Automatic Differentiation
 
Loading...
Searching...
No Matches
stan::math::check_cl_< T > Class Template Reference

Detailed Description

template<typename T>
class stan::math::check_cl_< T >

Represents a check in kernel generator expressions.

When a check is assigned an expression it will throw if any value in the result of the expression is false.

Template Parameters
Ttype of matrix_cl or expression that is checked

Definition at line 28 of file check_cl.hpp.

#include <check_cl.hpp>

+ Inheritance diagram for stan::math::check_cl_< T >:

Public Types

using Scalar = bool
 
using base = operation_cl_lhs< check_cl_< T >, bool >
 
using Deriv = Derived
 
using ArgsTuple = std::tuple< Args... >
 
using view_transitivity = std::tuple< std::is_same< Args, void >... >
 

Public Member Functions

 check_cl_ (const char *function, const char *err_variable, T &&y, const char *must_be)
 Constructor.
 
kernel_parts get_kernel_parts (...)=delete
 
void extreme_diagonals (...)=delete
 
kernel_parts get_kernel_parts_lhs (std::unordered_map< const void *, const char * > &generated, std::unordered_map< const void *, const char * > &generated_all, name_generator &name_gen, const std::string &row_index_name, const std::string &col_index_name) const
 Generates kernel code for this and nested expressions.
 
void set_args (std::unordered_map< const void *, const char * > &generated, std::unordered_map< const void *, const char * > &generated_all, cl::Kernel &kernel, int &arg_num) const
 Sets kernel arguments for this expression.
 
void check_assign_dimensions (int rows, int cols) const
 Checks if desired dimensions match dimensions of the argument.
 
void get_clear_read_write_events (std::vector< cl::Event > &events) const
 Adds all write events on any matrices used by nested expression to a list.
 
void add_write_event (cl::Event &e) const
 Instead of adding event to matrices, waits on the event and throws if check failed.
 
int rows () const
 Number of rows of a matrix that would be the result of evaluating this expression.
 
int cols () const
 Number of columns of a matrix that would be the result of evaluating this expression.
 
void operator= (bool condition)
 Assignment of a scalar bool triggers the scalar check.
 
kernel_parts generate_lhs (const std::string &row_index_name, const std::string &col_index_name, const std::string &var_name_arg) const
 Generates kernel code for this and nested expressions if this expression appears on the left hand side of an assignment.
 
void set_view (int bottom_diagonal, int top_diagonal, int bottom_zero_diagonal, int top_zero_diagonal) const
 Sets the view of the underlying matrix depending on which of its parts are written to.
 
Derived & derived ()
 Casts the instance into its derived type.
 
const Derived & derived () const
 Casts the instance into its derived type.
 
template<size_t N>
const auto & get_arg () const
 Returns an argument to this operation.
 
matrix_cl< Scalareval () const
 Evaluates the expression.
 
template<typename T_lhs >
void evaluate_into (T_lhs &lhs) const
 Evaluates this expression into given left-hand-side expression.
 
template<typename T_lhs >
std::string get_kernel_source_for_evaluating_into (const T_lhs &lhs) const
 Generates kernel source for evaluating this expression into given left-hand-side expression.
 
template<typename T_result >
kernel_parts get_whole_kernel_parts (std::unordered_map< const void *, const char * > &generated, std::unordered_map< const void *, const char * > &generated_all, name_generator &ng, const std::string &row_index_name, const std::string &col_index_name, const T_result &result) const
 Generates kernel code for assigning this expression into result expression.
 
kernel_parts get_kernel_parts (std::unordered_map< const void *, const char * > &generated, std::unordered_map< const void *, const char * > &generated_all, name_generator &name_gen, const std::string &row_index_name, const std::string &col_index_name, bool view_handled) const
 Generates kernel code for this and nested expressions.
 
kernel_parts generate (const std::string &row_index_name, const std::string &col_index_name, const bool view_handled, const std::string &var_name_arg) const
 Generates kernel code for this expression.
 
void modify_argument_indices (std::string &row_index_name, std::string &col_index_name) const
 Does nothing.
 
void add_read_event (cl::Event &e) const
 Adds read event to any matrices used by nested expressions.
 
void get_write_events (std::vector< cl::Event > &events) const
 Adds all write events on any matrices used by nested expressions to a list.
 
int size () const
 Size of a matrix that would be the result of evaluating this expression.
 
int thread_rows () const
 Number of rows threads need to be launched for.
 
int thread_cols () const
 Number of columns threads need to be launched for.
 
std::pair< int, int > extreme_diagonals () const
 Determine indices of extreme sub- and superdiagonals written.
 
matrix_cl_view view () const
 View of a matrix that would be the result of evaluating this expression.
 
void get_unique_matrix_accesses (std::vector< int > &uids, std::unordered_map< const void *, int > &id_map, int &next_id) const
 Collects data that is needed beside types to uniqly identify a kernel generator expression.
 

Public Attributes

arg_
 
const char * function_
 
const char * err_variable_
 
const char * must_be_
 

Static Public Attributes

static const bool require_specific_local_size
 
static constexpr int dynamic = -1
 

Protected Attributes

matrix_cl< int > buffer_
 
matrix_cl< value_type_t< T > > value_
 
std::tuple< Args... > arguments_
 
std::string var_name_
 

Static Protected Attributes

static constexpr int N
 

The documentation for this class was generated from the following files: