Filter of a xexpression for fast scalar assign. More...

#include <xindex_view.hpp>

Public Types
using	self_type = xfiltration<ECT, CCT>
using	xexpression_type = std::decay_t<ECT>
using	const_reference = typename xexpression_type::const_reference

Public Member Functions
Constructor
template<class ECTA, class CCTA>
	xfiltration (ECTA &&e, CCTA &&condition)
	Constructs a xfiltration on the given expression `e`, selecting the elements matching the specified `condition`.
Extended copy semantic
template<class E>
disable_xexpression< E, self_type & >	operator= (const E &)
	Assigns the scalar `e` to `*this`.

Computed assignement
template<class E>
disable_xexpression< E, self_type & >	operator+= (const E &)
	Adds the scalar `e` to `*this`.
template<class E>
disable_xexpression< E, self_type & >	operator-= (const E &)
	Subtracts the scalar `e` from `*this`.
template<class E>
disable_xexpression< E, self_type & >	operator*= (const E &)
	Multiplies `*this` with the scalar `e`.
template<class E>
disable_xexpression< E, self_type & >	operator/= (const E &)
	Divides `*this` by the scalar `e`.
template<class E>
disable_xexpression< E, self_type & >	operator%= (const E &)
	Computes the remainder of `*this` after division by the scalar `e`.

Detailed Description

template<class ECT, class CCT>
class xt::xfiltration< ECT, CCT >

Filter of a xexpression for fast scalar assign.

The xfiltration class implements a lazy filtration of a multidimentional xexpression, optimized for scalar and computed scalar assignments. Actually, the xfiltration class IS NOT an xexpression and the scalar and computed scalar assignments are the only method it provides. The filtering condition is not evaluated until the filtration is assigned.

xfiltration is not meant to be used directly, but only with the filtration helper function.

Template Parameters

ECT	the closure type of the xexpression type underlying this filtration
CCR	the closure type of the filtering xexpression type

See also: filtration

Definition at line 232 of file xindex_view.hpp.

Member Typedef Documentation

◆ const_reference

template<class ECT, class CCT>

using xt::xfiltration< ECT, CCT >::const_reference = typename xexpression_type::const_reference

Definition at line 238 of file xindex_view.hpp.

◆ self_type

template<class ECT, class CCT>

using xt::xfiltration< ECT, CCT >::self_type = xfiltration<ECT, CCT>

Definition at line 236 of file xindex_view.hpp.

◆ xexpression_type

template<class ECT, class CCT>

using xt::xfiltration< ECT, CCT >::xexpression_type = std::decay_t<ECT>

Definition at line 237 of file xindex_view.hpp.

Constructor & Destructor Documentation

◆ xfiltration()

template<class ECT, class CCT>

template<class ECTA, class CCTA>

xt::xfiltration< ECT, CCT >::xfiltration	(	ECTA &&	e,
		CCTA &&	condition )

inline

Constructs a xfiltration on the given expression e, selecting the elements matching the specified condition.

Parameters

e	the xexpression to filter.
condition	the filtering xexpression to apply.

Definition at line 641 of file xindex_view.hpp.

Member Function Documentation

◆ operator%=()

template<class ECT, class CCT>

template<class E>

auto xt::xfiltration< ECT, CCT >::operator%= ( const E & e ) -> disable_xexpression< E, self_type & >

inline

Computes the remainder of *this after division by the scalar e.

Parameters

e	the scalar involved in the operation.

Returns: a reference to *this.

Definition at line 751 of file xindex_view.hpp.

◆ operator*=()

template<class ECT, class CCT>

template<class E>

auto xt::xfiltration< ECT, CCT >::operator*= ( const E & e ) -> disable_xexpression< E, self_type & >

inline

Multiplies *this with the scalar e.

Parameters

e	the scalar involved in the operation.

Returns: a reference to *this.

Definition at line 717 of file xindex_view.hpp.

◆ operator+=()

template<class ECT, class CCT>

template<class E>

auto xt::xfiltration< ECT, CCT >::operator+= ( const E & e ) -> disable_xexpression< E, self_type & >

inline

Adds the scalar e to *this.

Parameters

e	the scalar to add.

Returns: a reference to *this.

Definition at line 683 of file xindex_view.hpp.

◆ operator-=()

template<class ECT, class CCT>

template<class E>

auto xt::xfiltration< ECT, CCT >::operator-= ( const E & e ) -> disable_xexpression< E, self_type & >

inline

Subtracts the scalar e from *this.

Parameters

e	the scalar to subtract.

Returns: a reference to *this.

Definition at line 700 of file xindex_view.hpp.

◆ operator/=()

template<class ECT, class CCT>

template<class E>

auto xt::xfiltration< ECT, CCT >::operator/= ( const E & e ) -> disable_xexpression< E, self_type & >

inline

Divides *this by the scalar e.

Parameters

e	the scalar involved in the operation.

Returns: a reference to *this.

Definition at line 734 of file xindex_view.hpp.

◆ operator=()

template<class ECT, class CCT>

template<class E>

auto xt::xfiltration< ECT, CCT >::operator= ( const E & e ) -> disable_xexpression< E, self_type & >

inline

Assigns the scalar e to *this.

Parameters

e	the scalar to assign.

Returns: a reference to \ *this.

Definition at line 660 of file xindex_view.hpp.

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

/home/runner/work/xtensor/xtensor/include/xtensor/views/xindex_view.hpp

Public Types

Public Member Functions

Computed assignement

Detailed Description

Member Typedef Documentation

◆ const_reference

◆ self_type

◆ xexpression_type

Constructor & Destructor Documentation

◆ xfiltration()

Member Function Documentation

◆ operator%=()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator=()