Detailed Description

Automatic assignment uses lazy expressions and placeholders to simplify assigning values to multi-dimensional arrays/views and other container like objects.

The following example shows how to fill a 2-dimensional nda::array of size 3 with the values 0, 1, 2, 10, 11 and 12:

nda::clef::placeholder<0> i_;
nda::clef::placeholder<1> j_;
nda::array<int, 2> a(2, 3);
a(i_, j_) << 10 * i_ + j_;

Note: The operator<< in line 3 calls the clef_auto_assign overload for nda::array objects.

We can also use auto assignment to fill a std::vector of size 3 with the values 10, 20 and 30:

nda::clef::placeholder<0> i_;
std::vector<int> v(3);
nda::clef::make_expr(v)[i_] << 10 * (i_ + 1);

Note: The operator<< in line 3 calls the clef_auto_assign_subscript overload for std::vector objects.

Functions
template<typename Tag , typename... Childs, typename RHS >
__inline__ void	nda::clef::clef_auto_assign (expr< Tag, Childs... > const &ex, RHS const &rhs)
	Overload of `clef_auto_assign` function for generic expressions.

template<typename T , typename RHS >
__inline__ void	nda::clef::clef_auto_assign (expr< tags::terminal, T > const &ex, RHS &&rhs)
	Overload of `clef_auto_assign` function for terminal expressions.

template<typename T , typename RHS >
__inline__ void	nda::clef::clef_auto_assign (std::reference_wrapper< T > wrapper, RHS &&rhs)
	Overload of `clef_auto_assign` function for std::reference_wrapper objects.

template<Array A, typename F >
void	nda::clef_auto_assign (A &&a, F &&f)
	Overload of nda::clef::clef_auto_assign function for nda::Array objects.

template<typename Tag , typename... Childs, typename RHS >
__inline__ void	nda::clef::clef_auto_assign_subscript (expr< Tag, Childs... > const &ex, RHS const &rhs)
	Overload of `clef_auto_assign_subscript` function for generic expressions.

template<typename T , typename RHS >
__inline__ void	nda::clef::clef_auto_assign_subscript (expr< tags::terminal, T > const &ex, RHS &&rhs)
	Overload of `clef_auto_assign_subscript` function for terminal expressions.

template<typename T , typename RHS >
__inline__ void	nda::clef::clef_auto_assign_subscript (std::reference_wrapper< T > wrapper, RHS &&rhs)
	Overload of `clef_auto_assign_subscript` function for std::reference_wrapper objects.

template<typename T , typename F >
void	nda::clef::clef_auto_assign_subscript (std::vector< T > &v, F f)
	Overload of `clef_auto_assign_subscript` function for std::vector.

template<typename F , typename RHS , int... Is>
__inline__ void	nda::clef::operator<< (expr< tags::function, F, placeholder< Is >... > const &ex, RHS &&rhs)
	Assign values to the underlying object of a lazy function call expression.

template<typename T , typename RHS , int... Is>
__inline__ void	nda::clef::operator<< (expr< tags::subscript, T, placeholder< Is >... > const &ex, RHS &&rhs)
	Assign values to the underlying object of a lazy subscript expression.

Function Documentation

◆ clef_auto_assign() [1/4]

template<typename Tag , typename... Childs, typename RHS >

__inline__ void nda::clef::clef_auto_assign	(	expr< Tag, Childs... > const &	ex,
		RHS const &	rhs )

#include <nda/clef/auto_assign.hpp>

Overload of clef_auto_assign function for generic expressions.

It calls the specialized operator<< function for the given expression and right-hand side.

Template Parameters

Tag	Tag of the expression.
Childs	Types of the child nodes.
RHS	Type of the right-hand side.

Parameters

ex	nda::clef::expr object.
rhs	Right-hand side object.

Definition at line 83 of file auto_assign.hpp.

◆ clef_auto_assign() [2/4]

template<typename T , typename RHS >

__inline__ void nda::clef::clef_auto_assign	(	expr< tags::terminal, T > const &	ex,
		RHS &&	rhs )

#include <nda/clef/auto_assign.hpp>

Overload of clef_auto_assign function for terminal expressions.

Simply calls the clef_auto_assign for the child node of the expression.

Template Parameters

T	Type of the expression's child node.
RHS	Type of the right-hand side.

Parameters

ex	nda::clef::expr object with the nda::clef::tags::terminal tag.
rhs	Right-hand side object.

Definition at line 67 of file auto_assign.hpp.

◆ clef_auto_assign() [3/4]

template<typename T , typename RHS >

__inline__ void nda::clef::clef_auto_assign	(	std::reference_wrapper< T >	wrapper,
		RHS &&	rhs )

#include <nda/clef/auto_assign.hpp>

Overload of clef_auto_assign function for std::reference_wrapper objects.

Simply calls the clef_auto_assign for the object contained in the wrapper.

Template Parameters

T	Type of the object stored in the std::reference_wrapper.
RHS	Type of the right-hand side.

Parameters

wrapper	std::reference_wrapper object.
rhs	Right-hand side object.

Definition at line 52 of file auto_assign.hpp.

◆ clef_auto_assign() [4/4]

template<Array A, typename F >

void nda::clef_auto_assign	(	A &&	a,
		F &&	f )

#include <nda/basic_functions.hpp>

Overload of nda::clef::clef_auto_assign function for nda::Array objects.

Template Parameters

A	nda::Array type.
F	Callable type.

Parameters

a	nda::Array object.
f	Callable object.

Definition at line 532 of file basic_functions.hpp.

◆ clef_auto_assign_subscript() [1/4]

template<typename Tag , typename... Childs, typename RHS >

__inline__ void nda::clef::clef_auto_assign_subscript	(	expr< Tag, Childs... > const &	ex,
		RHS const &	rhs )

#include <nda/clef/auto_assign_subscript.hpp>

Overload of clef_auto_assign_subscript function for generic expressions.

It calls the specialized operator<< function for the given expression and right-hand side.

Template Parameters

Tag	Tag of the expression.
Childs	Types of the child nodes.
RHS	Type of the right-hand side.

Parameters

ex	nda::clef::expr object.
rhs	Right-hand side object.

Definition at line 87 of file auto_assign_subscript.hpp.

◆ clef_auto_assign_subscript() [2/4]

template<typename T , typename RHS >

__inline__ void nda::clef::clef_auto_assign_subscript	(	expr< tags::terminal, T > const &	ex,
		RHS &&	rhs )

#include <nda/clef/auto_assign_subscript.hpp>

Overload of clef_auto_assign_subscript function for terminal expressions.

Simply calls the clef_auto_assign_subscript for the child node of the expression.

Template Parameters

T	Type of the expression's child node.
RHS	Type of the right-hand side.

Parameters

ex	nda::clef::expr object with the nda::clef::tags::terminal tag.
rhs	Right-hand side object.

Definition at line 71 of file auto_assign_subscript.hpp.

◆ clef_auto_assign_subscript() [3/4]

template<typename T , typename RHS >

__inline__ void nda::clef::clef_auto_assign_subscript	(	std::reference_wrapper< T >	wrapper,
		RHS &&	rhs )

#include <nda/clef/auto_assign_subscript.hpp>

Overload of clef_auto_assign_subscript function for std::reference_wrapper objects.

Simply calls the clef_auto_assign_subscript for the object contained in the wrapper.

Template Parameters

T	Type of the object stored in the std::reference_wrapper.
RHS	Type of the right-hand side.

Parameters

wrapper	std::reference_wrapper object.
rhs	Right-hand side object.

Definition at line 56 of file auto_assign_subscript.hpp.

◆ clef_auto_assign_subscript() [4/4]

template<typename T , typename F >

void nda::clef::clef_auto_assign_subscript	(	std::vector< T > &	v,
		F	f )

#include <nda/clef/adapters/vector.hpp>

Overload of clef_auto_assign_subscript function for std::vector.

Template Parameters

T	Value type of the std::vector.
F	Callable type.

Parameters

v	std::vector object.
f	Callable object.

Definition at line 61 of file vector.hpp.

◆ operator<<() [1/2]

template<typename F , typename RHS , int... Is>

__inline__ void nda::clef::operator<<	(	expr< tags::function, F, placeholder< Is >... > const &	ex,
		RHS &&	rhs )

#include <nda/clef/auto_assign.hpp>

Assign values to the underlying object of a lazy function call expression.

This calls the clef_auto_assign overload for the underlying object of the given expression using ADL. It has to be implemented for all supported types.

Template Parameters

F	Type of the callable object in the function call expression.
RHS	Type of the right-hand side.
Is	Integer labels of the placeholders in the function call expression.

Parameters

ex	nda::clef::expr object with the nda::clef::tags::function tag.
rhs	Right-hand side object.

Definition at line 106 of file auto_assign.hpp.

◆ operator<<() [2/2]

template<typename T , typename RHS , int... Is>

__inline__ void nda::clef::operator<<	(	expr< tags::subscript, T, placeholder< Is >... > const &	ex,
		RHS &&	rhs )

#include <nda/clef/auto_assign_subscript.hpp>

Assign values to the underlying object of a lazy subscript expression.

This calls the clef_auto_assign_subscript overload for the underlying object of the given expression using ADL. It has to be implemented for all supported types.

Template Parameters

T	Type of the subscripted object in the subscript expression.
RHS	Type of the right-hand side.
Is	Integer labels of the placeholders in the subscript expression.

Parameters

ex	nda::clef::expr object with the nda::clef::tags::subscript tag.
rhs	Right-hand side object.

Definition at line 110 of file auto_assign_subscript.hpp.

Detailed Description

Functions

Function Documentation

◆ clef_auto_assign() [1/4]

◆ clef_auto_assign() [2/4]

◆ clef_auto_assign() [3/4]

◆ clef_auto_assign() [4/4]

◆ clef_auto_assign_subscript() [1/4]

◆ clef_auto_assign_subscript() [2/4]

◆ clef_auto_assign_subscript() [3/4]

◆ clef_auto_assign_subscript() [4/4]

◆ operator<<() [1/2]

◆ operator<<() [2/2]