STK++ 0.9.13
STK::UpperSymmetrizeOperator< Lhs > Class Template Reference

Generic expression when we want to get the upper-part of a two-dimensional symmetric expression. More...

#include <STK_ReshapeOperators.h>

Inheritance diagram for STK::UpperSymmetrizeOperator< Lhs >:
Inheritance graph

Public Types

enum  {
  structure_ = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::structure_ , orient_ = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::orient_ , sizeRows_ = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::sizeRows_ , sizeCols_ = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::sizeCols_ ,
  storage_ = hidden::Traits< UpperSymmetrizeOperator<Lhs> >::storage_
}
typedef ExprBase< UpperSymmetrizeOperator< Lhs > > Base
typedef hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type Type
typedef hidden::Traits< UpperSymmetrizeOperator< Lhs > >::TypeConst TypeConst
typedef TRange< sizeRows_ > RowRange
 Type of the Range for the rows.
typedef TRange< sizeCols_ > ColRange
 Type of the Range for the columns.
Public Types inherited from STK::ExprBase< UpperSymmetrizeOperator< Lhs > >
typedef ITContainer< UpperSymmetrizeOperator< Lhs >, structure_ > Base
typedef hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type Type
typedef hidden::Traits< UpperSymmetrizeOperator< Lhs > >::TypeConst TypeConst
enum  

Public Member Functions

 UpperSymmetrizeOperator (Lhs const &lhs)
 Constructor.
Lhs const & lhs () const
RowRange const & rowsImpl () const
ColRange const & colsImpl () const
TypeConst elt2Impl (int i, int j) const
Public Member Functions inherited from STK::ExprBase< UpperSymmetrizeOperator< Lhs > >
Visitor::TypeConst visit (Visitor &visitor) const
 Visit the container using a constant visitor.
int count () const
 compute the value of non-zero element in an expression.
bool const any () const
 check if there is any non-zero element in an expression.
bool const all () const
 check if all the elements in an expression are not zero.
int nbAvailableValues () const
Type const minElt (int &row, int &col) const
Type const minEltSafe (int &row, int &col) const
Type const maxElt (int &row, int &col) const
Type const maxEltSafe (int &row, int &col) const
Type const minElt (int &pos) const
Type const minEltSafe (int &pos) const
Type const maxElt (int &pos) const
Type const maxEltSafe (int &pos) const
Type const minElt () const
Type const minEltSafe () const
Type const maxElt () const
Type const maxEltSafe () const
Type const sum () const
Type const sumSafe () const
Type const norm () const
Type const normSafe () const
Type const norm2 () const
Type const norm2Safe () const
Type const normInf () const
Type const mean () const
Type const meanSafe () const
Type const variance () const
Type const varianceSafe () const
Type const variance (Type const &mean) const
Type const varianceSafe (Type const &mean) const
Type const wsum (ExprBase< Rhs > const &weights) const
Type const wsumSafe (ExprBase< Rhs > const &weights) const
Type const wnorm (ExprBase< Rhs > const &weights) const
Type const wnormSafe (ExprBase< Rhs > const &weights) const
Type const wnorm2 (ExprBase< Rhs > const &weights) const
Type const wnorm2Safe (ExprBase< Rhs > const &weights) const
Type const wmean (ExprBase< Rhs > const &weights) const
Type const wmeanSafe (ExprBase< Rhs > const &weights) const
Type const wvariance (ExprBase< Rhs > const &weights) const
Type const wvarianceSafe (ExprBase< Rhs > const &weights) const
Type const wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
Type const wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::equalOp_ >::Result const operator== (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::notEqualOp_ >::Result const operator!= (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::greaterThanOp_ >::Result const operator> (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::lessThanOp_ >::Result const operator< (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::greaterThanOrEqualOp_ >::Result const operator>= (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::lessThanOrEqualOp_ >::Result const operator<= (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::sumOp_ >::Result const operator+ (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::differenceOp_ >::Result const operator- (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::productOp_ >::Result const prod (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::divisionOp_ >::Result const operator/ (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::moduloOp_ >::Result const operator% (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::minOp_ >::Result const min (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::maxOp_ >::Result const max (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::logicalAndOp_ >::Result const operator&& (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::logicalOrOp_ >::Result const operator|| (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::bitwiseAndOp_ >::Result const operator& (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::bitwiseOrOp_ >::Result const operator| (ExprBase< Rhs > const &other) const
hidden::OperatorSelector< UpperSymmetrizeOperator< Lhs >, Rhs, Arrays::bitwiseXorOp_ >::Result const operator^ (ExprBase< Rhs > const &other) const
UnaryOperator< OppositeOp< Type >, UpperSymmetrizeOperator< Lhs > > operator- () const
UnaryOperator< IsNaOp< Type >, UpperSymmetrizeOperator< Lhs > > isNA () const
UnaryOperator< NegOp< Type >, UpperSymmetrizeOperator< Lhs > > neg () const
UnaryOperator< IsFiniteOp< Type >, UpperSymmetrizeOperator< Lhs > > isFinite () const
UnaryOperator< IsInfiniteOp< Type >, UpperSymmetrizeOperator< Lhs > > isInfinite () const
UnaryOperator< AbsOp< Type >, UpperSymmetrizeOperator< Lhs > > abs () const
UnaryOperator< ExpOp< Type >, UpperSymmetrizeOperator< Lhs > > exp () const
UnaryOperator< LogOp< Type >, UpperSymmetrizeOperator< Lhs > > log () const
UnaryOperator< SqrtOp< Type >, UpperSymmetrizeOperator< Lhs > > sqrt () const
UnaryOperator< CosOp< Type >, UpperSymmetrizeOperator< Lhs > > cos () const
UnaryOperator< SinOp< Type >, UpperSymmetrizeOperator< Lhs > > sin () const
UnaryOperator< AcosOp< Type >, UpperSymmetrizeOperator< Lhs > > acos () const
UnaryOperator< AsinOp< Type >, UpperSymmetrizeOperator< Lhs > > asin () const
UnaryOperator< TanOp< Type >, UpperSymmetrizeOperator< Lhs > > tan () const
UnaryOperator< InverseOp< Type >, UpperSymmetrizeOperator< Lhs > > inverse () const
UnaryOperator< SquareOp< Type >, UpperSymmetrizeOperator< Lhs > > square () const
UnaryOperator< CubeOp< Type >, UpperSymmetrizeOperator< Lhs > > cube () const
UnaryOperator< EqualWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator== (Type const &value) const
UnaryOperator< NotEqualWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator!= (Type const &value) const
UnaryOperator< GreaterThanOp< Type >, UpperSymmetrizeOperator< Lhs > > operator> (Type const &value) const
UnaryOperator< LessThanOp< Type >, UpperSymmetrizeOperator< Lhs > > operator< (Type const &value) const
UnaryOperator< LeqThanOp< Type >, UpperSymmetrizeOperator< Lhs > > operator<= (Type const &value) const
UnaryOperator< GeqThanOp< Type >, UpperSymmetrizeOperator< Lhs > > operator>= (Type const &value) const
UnaryOperator< MinWithOp< Type >, UpperSymmetrizeOperator< Lhs > > min (Type const &value) const
UnaryOperator< MaxWithOp< Type >, UpperSymmetrizeOperator< Lhs > > max (Type const &value) const
UnaryOperator< SumWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator+ (Type const &value) const
UnaryOperator< DifferenceWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator- (Type const &value) const
UnaryOperator< ProductWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator* (Type const &value) const
UnaryOperator< DivisionWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator/ (Type const &value) const
UnaryOperator< ModuloWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator% (Type const &value) const
UnaryOperator< LogicalAndWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator&& (Type const &value) const
UnaryOperator< LogicalOrWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator|| (Type const &value) const
UnaryOperator< BitwiseAndWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator& (Type const &value) const
UnaryOperator< BitwiseOrWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator| (Type const &value) const
UnaryOperator< BitwiseXorWithOp< Type >, UpperSymmetrizeOperator< Lhs > > operator^ (Type const &value) const
UnaryOperator< PowOp< Type >, UpperSymmetrizeOperator< Lhs > > pow (Type const &value) const
UnaryOperator< SafeInverseOp< Type >, UpperSymmetrizeOperator< Lhs > > safeInverse (Type const &value) const
UnaryOperator< SafeOp< Type >, UpperSymmetrizeOperator< Lhs > > const safe (Type const value=Type()) const
UnaryOperator< CastOp< Type, OtherType >, UpperSymmetrizeOperator< Lhs > > const cast () const
UnaryOperator< Law::PdfOp< Type >, UpperSymmetrizeOperator< Lhs > > pdf (Law::IUnivLaw< Type > const &law) const
 compute pdf values to this using distribution law given by user
UnaryOperator< Law::LogPdfOp< Type >, UpperSymmetrizeOperator< Lhs > > lpdf (Law::IUnivLaw< Type > const &law) const
 compute log-pdf values to this using distribution law given by user
UnaryOperator< Law::CdfOp< Type >, UpperSymmetrizeOperator< Lhs > > cdf (Law::IUnivLaw< Type > const &law) const
 compute cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::LogCdfOp< Type >, UpperSymmetrizeOperator< Lhs > > lcdf (Law::IUnivLaw< Type > const &law) const
 compute log-cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::CdfcOp< Type >, UpperSymmetrizeOperator< Lhs > > cdfc (Law::IUnivLaw< Type > const &law) const
 compute complementary cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::LogCdfcOp< Type >, UpperSymmetrizeOperator< Lhs > > lcdfc (Law::IUnivLaw< Type > const &law) const
 compute complementary cumulative distribution function of this using distribution law given by user
UnaryOperator< Law::IcdfOp< Type >, UpperSymmetrizeOperator< Lhs > > icdf (Law::IUnivLaw< Type > const &law) const
 compute inverse cumulative distribution function using distribution law given by user
UnaryOperator< OtherOperator< Type >, UpperSymmetrizeOperator< Lhs > > const funct0 () const
UnaryOperator< OtherOperator< Type >, UpperSymmetrizeOperator< Lhs > > const funct1 (Type const value) const
TransposeOperator< UpperSymmetrizeOperator< Lhs > > const transpose () const
DiagonalizeOperator< UpperSymmetrizeOperator< Lhs > > const diagonalize () const
DiagonalGetterOperator< UpperSymmetrizeOperator< Lhs > > const getDiagonal () const
UpperTriangularizeOperator< UpperSymmetrizeOperator< Lhs > > const upperTriangularize () const
LowerTriangularizeOperator< UpperSymmetrizeOperator< Lhs > > const lowerTriangularize () const
SymmetrizeOperator< UpperSymmetrizeOperator< Lhs > > const symmetrize () const
UpperSymmetrizeOperator< Derived > const upperSymmetrize () const
LowerSymmetrizeOperator< UpperSymmetrizeOperator< Lhs > > const lowerSymmetrize () const
SubVectorOperator< UpperSymmetrizeOperator< Lhs >, Size_ > const sub (TRange< Size_ > const &I) const
ColOperator< UpperSymmetrizeOperator< Lhs > > const col (int j) const
RowOperator< UpperSymmetrizeOperator< Lhs > > const row (int i) const
SubOperator< UpperSymmetrizeOperator< Lhs >, sizeRows_, Size_ > const col (TRange< Size_ > const &J) const
SubOperator< UpperSymmetrizeOperator< Lhs >, Size_, sizeCols_ > const row (TRange< Size_ > const &I) const
SubOperator< UpperSymmetrizeOperator< Lhs >, SizeRows_, SizeCols_ > const sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J) const
hidden::Promote< Type, typenameRhs::Type >::result_type const dot (ExprBase< Rhs > const &other) const
hidden::Promote< Type, typenameRhs::Type >::result_type const dotSafe (ExprBase< Rhs > const &other) const
hidden::ProductSelector< UpperSymmetrizeOperator< Lhs >, Rhs, hidden::Traits< UpperSymmetrizeOperator< Lhs > >::structure_, hidden::Traits< Rhs >::structure_ >::ProductType const operator* (ExprBase< Rhs > const &other) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wsum (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wsumSafe (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wnorm (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wnormSafe (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wnorm2 (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wnorm2Safe (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wmean (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wmeanSafe (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wvariance (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wvarianceSafe (ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
hidden::Traits< UpperSymmetrizeOperator< Lhs > >::Type const wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const

Protected Attributes

Lhs const & lhs_

Additional Inherited Members

Static Public Member Functions inherited from STK::TRef< 1 >
static bool isRef ()
Protected Member Functions inherited from STK::ExprBase< UpperSymmetrizeOperator< Lhs > >
 ExprBase ()
 Default constructor.
 ~ExprBase ()
 destructor

Detailed Description

template<typename Lhs>
class STK::UpperSymmetrizeOperator< Lhs >

Generic expression when we want to get the upper-part of a two-dimensional symmetric expression.

Template Parameters
Lhsthe type of the expression to which we are applying the UpperSymmetrizeOperator operator.

This class represents an expression where an UpperSymmetrizeOperator operator is applied to an expression. It is the return type of the upperSymmetrize operation.

Most of the time, this is the only way that it is used, so you typically don't have to name UpperSymmetrizeOperator type explicitly.

Definition at line 555 of file STK_ReshapeOperators.h.

Member Typedef Documentation

◆ Base

template<typename Lhs>
typedef ExprBase< UpperSymmetrizeOperator< Lhs> > STK::UpperSymmetrizeOperator< Lhs >::Base

Definition at line 558 of file STK_ReshapeOperators.h.

◆ ColRange

template<typename Lhs>
typedef TRange<sizeCols_> STK::UpperSymmetrizeOperator< Lhs >::ColRange

Type of the Range for the columns.

Definition at line 573 of file STK_ReshapeOperators.h.

◆ RowRange

template<typename Lhs>
typedef TRange<sizeRows_> STK::UpperSymmetrizeOperator< Lhs >::RowRange

Type of the Range for the rows.

Definition at line 571 of file STK_ReshapeOperators.h.

◆ Type

template<typename Lhs>
typedef hidden::Traits<UpperSymmetrizeOperator<Lhs>>::Type STK::UpperSymmetrizeOperator< Lhs >::Type

Definition at line 559 of file STK_ReshapeOperators.h.

◆ TypeConst

template<typename Lhs>
typedef hidden::Traits<UpperSymmetrizeOperator<Lhs>>::TypeConst STK::UpperSymmetrizeOperator< Lhs >::TypeConst

Definition at line 560 of file STK_ReshapeOperators.h.

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ UpperSymmetrizeOperator()

template<typename Lhs>
STK::UpperSymmetrizeOperator< Lhs >::UpperSymmetrizeOperator ( Lhs const & lhs)
inline

Constructor.

Definition at line 576 of file STK_ReshapeOperators.h.

576 : Base(), lhs_(lhs)
#define STK_STATIC_ASSERT_TWO_DIMENSIONS_ONLY(EXPR)
ExprBase< UpperSymmetrizeOperator< Lhs > > Base

References lhs(), lhs_, and STK_STATIC_ASSERT_TWO_DIMENSIONS_ONLY.

Member Function Documentation

◆ colsImpl()

template<typename Lhs>
ColRange const & STK::UpperSymmetrizeOperator< Lhs >::colsImpl ( ) const
inline
Returns
the range of the Columns

Definition at line 583 of file STK_ReshapeOperators.h.

583{ return lhs().cols();}

References lhs().

◆ elt2Impl()

template<typename Lhs>
TypeConst STK::UpperSymmetrizeOperator< Lhs >::elt2Impl ( int i,
int j ) const
inline
Returns
a constant reference on the (i,j) element of the expression.
Parameters
i,jindex of the row and of the column

Definition at line 588 of file STK_ReshapeOperators.h.

589 { return ((j<i) ? lhs_.elt(j, i) : lhs_.elt(i, j));}

References lhs_.

◆ lhs()

template<typename Lhs>
Lhs const & STK::UpperSymmetrizeOperator< Lhs >::lhs ( ) const
inline
Returns
the left hand side expression

Definition at line 579 of file STK_ReshapeOperators.h.

579{ return lhs_; }

References lhs_.

Referenced by colsImpl(), rowsImpl(), and UpperSymmetrizeOperator().

◆ rowsImpl()

template<typename Lhs>
RowRange const & STK::UpperSymmetrizeOperator< Lhs >::rowsImpl ( ) const
inline
Returns
the range of the rows

Definition at line 581 of file STK_ReshapeOperators.h.

581{ return lhs().rows();}

References lhs().

Member Data Documentation

◆ lhs_

template<typename Lhs>
Lhs const& STK::UpperSymmetrizeOperator< Lhs >::lhs_
protected

Definition at line 592 of file STK_ReshapeOperators.h.

Referenced by elt2Impl(), lhs(), and UpperSymmetrizeOperator().


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