codac2::FlatInputBinding Struct Reference

Binding information associated with one input argument in a flattened input domain. More...

#include <codac2_analytic_flat_input_layout.h>

Public Member Functions
bool	is_scalar () const
	Tests whether the binding corresponds to a scalar input argument.
bool	is_vector () const
	Tests whether the binding corresponds to a vector input argument.
bool	is_matrix () const
	Tests whether the binding corresponds to a matrix input argument.

Public Attributes
std::type_index	type = typeid(ScalarType)
	Analytic type of the bound input argument.
Index	offset = 0
	First scalar index of the argument in the flattened domain.
Index	rows = 1
	Number of rows of the argument block.
Index	cols = 1
	Number of columns of the argument block.

Detailed Description

Binding information associated with one input argument in a flattened input domain.

An analytic function input argument may be scalar, vectorial or matricial. In a flattened input domain, each argument is represented by a contiguous block of scalar inputs.

The type field stores the analytic category of the argument and is one of:

• typeid(ScalarType)
• typeid(VectorType)
• typeid(MatrixType)

Member Function Documentation

is_scalar()

bool codac2::FlatInputBinding::is_scalar

(

)

const

Tests whether the binding corresponds to a scalar input argument.

Returns

True if the binding corresponds to a scalar input argument.

is_vector()

bool codac2::FlatInputBinding::is_vector

(

)

const

Tests whether the binding corresponds to a vector input argument.

Returns

True if the binding corresponds to a vector input argument.

is_matrix()

bool codac2::FlatInputBinding::is_matrix

(

)

const

Tests whether the binding corresponds to a matrix input argument.

Returns

True if the binding corresponds to a matrix input argument.

---

The documentation for this struct was generated from the following file:

• /home/simon/codac-simon/src/core/functions/analytic/codac2_analytic_flat_input_layout.h