Kratos::UnaryStatisticsExpression< TOperationType > Class Template Reference

Used to create lazy expression to get statistical quantities of entity values. More...

#include <unary_statistics_expression.h>

Inheritance diagram for Kratos::UnaryStatisticsExpression< TOperationType >:

Collaboration diagram for Kratos::UnaryStatisticsExpression< TOperationType >:

Public Types
Type definitions
using	IndexType = std::size_t
Public Types inherited from Kratos::Expression
using	Pointer = Kratos::intrusive_ptr< Expression >
using	ConstPointer = Kratos::intrusive_ptr< const Expression >
using	IndexType = std::size_t
using	value_type = double
using	size_type = IndexType
using	const_iterator = ExpressionIterator

Public Member Functions
Life cycle
	UnaryStatisticsExpression (Expression::ConstPointer pExpression)
Public Member Functions inherited from Kratos::Expression
	Expression (const IndexType NumberOfEntities)
virtual	~Expression ()=default
IndexType	NumberOfEntities () const
	Get the maximum number of entities allowed for this expression. More...
IndexType	GetItemComponentCount () const
	Get the Local Size of the expression. More...
IndexType	size () const
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const

Public operations
double	Evaluate (const IndexType EntityIndex, const IndexType EntityDataBeginIndex, const IndexType ComponentIndex) const override
	Evalute the expression for the given entity data start index and component index and returns the value. More...
const std::vector< IndexType >	GetItemShape () const override
	Get the Shape of the expression. More...
IndexType	GetMaxDepth () const override
	Get the Max Depth of the lazy expression tree. More...
std::string	Info () const override
static Expression::Pointer	Create (Expression::ConstPointer pExpression)

Detailed Description

template<class TOperationType>
class Kratos::UnaryStatisticsExpression< TOperationType >

Used to create lazy expression to get statistical quantities of entity values.

Member Typedef Documentation

IndexType

template<class TOperationType >

using Kratos::UnaryStatisticsExpression< TOperationType >::IndexType = std::size_t

Constructor & Destructor Documentation

UnaryStatisticsExpression()

template<class TOperationType >

Kratos::UnaryStatisticsExpression< TOperationType >::UnaryStatisticsExpression

(

Expression::ConstPointer

pExpression

)

Member Function Documentation

Create()

template<class TOperationType >

Expression::Pointer Kratos::UnaryStatisticsExpression< TOperationType >::Create ( Expression::ConstPointer  pExpression )

static

Evaluate()

template<class TOperationType >

double Kratos::UnaryStatisticsExpression< TOperationType >::Evaluate ( const IndexType  EntityIndex, const IndexType  EntityDataBeginIndex, const IndexType  ComponentIndex  ) const

overridevirtual

Evalute the expression for the given entity data start index and component index and returns the value.

Parameters

EntityIndex	Index of the entity.
EntityDataBeginIndex	Index at which entity data starts.
ComponentIndex	Component index.

Returns

double Evaluated expression.

Todo:

Move to private.

Implements Kratos::Expression.

GetItemShape()

template<class TOperationType >

const std::vector< std::size_t > Kratos::UnaryStatisticsExpression< TOperationType >::GetItemShape ( ) const

overridevirtual

Get the Shape of the expression.

Returns

const std::vector<IndexType> Size of each dimension is in the vector elements.

Implements Kratos::Expression.

GetMaxDepth()

template<class TOperationType >

std::size_t Kratos::UnaryStatisticsExpression< TOperationType >::GetMaxDepth ( ) const

overridevirtual

Get the Max Depth of the lazy expression tree.

Returns the maximum depth of the lazy expression tree.

Warning

This is a recursive computation, hence this should not be done repeatedly unless necessary.

Returns

IndexType Max depth of the lazy expression tree.

Implements Kratos::Expression.

Info()

template<class TOperationType >

std::string Kratos::UnaryStatisticsExpression< TOperationType >::Info

overridevirtual

Implements Kratos::Expression.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/expression/unary_statistics_expression.h
• /home/runner/work/Documentation/Documentation/master/kratos/expression/unary_statistics_expression.cpp