STK++ 0.9.13
STK::VectorByPointProduct< Lhs, Rhs > Class Template Reference

Generic expression where a product operator is applied to two expressions. More...

#include <STK_ProductOperators.h>

Inheritance diagram for STK::VectorByPointProduct< Lhs, Rhs >:
Inheritance graph

Public Types

enum  {
  structure_ = hidden::Traits<VectorByPointProduct>::structure_ , orient_ = hidden::Traits<VectorByPointProduct>::orient_ , sizeRows_ = hidden::Traits<VectorByPointProduct>::sizeRows_ , sizeCols_ = hidden::Traits<VectorByPointProduct>::sizeCols_ ,
  storage_ = hidden::Traits<VectorByPointProduct>::storage_
}
 
typedef ExprBase< VectorByPointProduct< Lhs, Rhs > > Base
 
typedef hidden::Traits< VectorByPointProduct >::Type Type
 
typedef hidden::Traits< VectorByPointProduct >::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< VectorByPointProduct< Lhs, Rhs > >
enum  
 
typedef ITContainer< VectorByPointProduct< Lhs, Rhs >, structure_ > Base
 
typedef hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type Type
 
typedef hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::TypeConst TypeConst
 

Public Member Functions

 VectorByPointProduct (const Lhs &lhs, const Rhs &rhs)
 constructor
 
RowRange constrowsImpl () const
 
ColRange constcolsImpl () const
 
TypeConst elt2Impl (int i, int j) const
 
TypeConst elt0Impl () const
 
Lhs constlhs () const
 
Rhs constrhs () const
 
- Public Member Functions inherited from STK::ExprBase< VectorByPointProduct< Lhs, Rhs > >
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 minElt (int &pos) const
 
Type const minElt () const
 
Type const minEltSafe (int &row, int &col) const
 
Type const minEltSafe (int &pos) const
 
Type const minEltSafe () const
 
Type const maxElt (int &row, int &col) const
 
Type const maxElt (int &pos) const
 
Type const maxElt () const
 
Type const maxEltSafe (int &row, int &col) const
 
Type const maxEltSafe (int &pos) 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 variance (Type const &mean) const
 
Type const varianceSafe () const
 
Type const varianceSafe (Type const &mean) const
 
Type const wsum (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wsum (ExprBase< Rhs > const &weights) const
 
Type const wsumSafe (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wsumSafe (ExprBase< Rhs > const &weights) const
 
Type const wnorm (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wnorm (ExprBase< Rhs > const &weights) const
 
Type const wnormSafe (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wnormSafe (ExprBase< Rhs > const &weights) const
 
Type const wnorm2 (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wnorm2 (ExprBase< Rhs > const &weights) const
 
Type const wnorm2Safe (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wnorm2Safe (ExprBase< Rhs > const &weights) const
 
Type const wmean (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wmean (ExprBase< Rhs > const &weights) const
 
Type const wmeanSafe (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wmeanSafe (ExprBase< Rhs > const &weights) const
 
Type const wvariance (ExprBase< Rhs > const &weights) const
 
Type const wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wvariance (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wvariance (Type const &mean, ExprBase< Rhs > const &weights) const
 
Type const wvarianceSafe (ExprBase< Rhs > const &weights) const
 
Type const wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wvarianceSafe (ExprBase< Rhs > const &weights) const
 
hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::Type const wvarianceSafe (Type const &mean, ExprBase< Rhs > const &weights) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::equalOp_ >::Result const operator== (ExprBase< Rhs > const &other) const
 
UnaryOperator< EqualWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator== (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::notEqualOp_ >::Result const operator!= (ExprBase< Rhs > const &other) const
 
UnaryOperator< NotEqualWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator!= (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::greaterThanOp_ >::Result const operator> (ExprBase< Rhs > const &other) const
 
UnaryOperator< GreaterThanOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator> (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::lessThanOp_ >::Result const operator< (ExprBase< Rhs > const &other) const
 
UnaryOperator< LessThanOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator< (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::greaterThanOrEqualOp_ >::Result const operator>= (ExprBase< Rhs > const &other) const
 
UnaryOperator< GeqThanOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator>= (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::lessThanOrEqualOp_ >::Result const operator<= (ExprBase< Rhs > const &other) const
 
UnaryOperator< LeqThanOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator<= (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::sumOp_ >::Result const operator+ (ExprBase< Rhs > const &other) const
 
UnaryOperator< SumWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator+ (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::differenceOp_ >::Result const operator- (ExprBase< Rhs > const &other) const
 
UnaryOperator< OppositeOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator- () const
 
UnaryOperator< DifferenceWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator- (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::productOp_ >::Result const prod (ExprBase< Rhs > const &other) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::divisionOp_ >::Result const operator/ (ExprBase< Rhs > const &other) const
 
UnaryOperator< DivisionWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator/ (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::moduloOp_ >::Result const operator% (ExprBase< Rhs > const &other) const
 
UnaryOperator< ModuloWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator% (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::minOp_ >::Result const min (ExprBase< Rhs > const &other) const
 
UnaryOperator< MinWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > min (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::maxOp_ >::Result const max (ExprBase< Rhs > const &other) const
 
UnaryOperator< MaxWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > max (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::logicalAndOp_ >::Result const operator&& (ExprBase< Rhs > const &other) const
 
UnaryOperator< LogicalAndWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator&& (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::logicalOrOp_ >::Result const operator|| (ExprBase< Rhs > const &other) const
 
UnaryOperator< LogicalOrWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator|| (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::bitwiseAndOp_ >::Result const operator& (ExprBase< Rhs > const &other) const
 
UnaryOperator< BitwiseAndWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator& (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::bitwiseOrOp_ >::Result const operator| (ExprBase< Rhs > const &other) const
 
UnaryOperator< BitwiseOrWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator| (Type const &value) const
 
hidden::OperatorSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, Arrays::bitwiseXorOp_ >::Result const operator^ (ExprBase< Rhs > const &other) const
 
UnaryOperator< BitwiseXorWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator^ (Type const &value) const
 
UnaryOperator< IsNaOp< Type >, VectorByPointProduct< Lhs, Rhs > > isNA () const
 
UnaryOperator< NegOp< Type >, VectorByPointProduct< Lhs, Rhs > > neg () const
 
UnaryOperator< IsFiniteOp< Type >, VectorByPointProduct< Lhs, Rhs > > isFinite () const
 
UnaryOperator< IsInfiniteOp< Type >, VectorByPointProduct< Lhs, Rhs > > isInfinite () const
 
UnaryOperator< AbsOp< Type >, VectorByPointProduct< Lhs, Rhs > > abs () const
 
UnaryOperator< ExpOp< Type >, VectorByPointProduct< Lhs, Rhs > > exp () const
 
UnaryOperator< LogOp< Type >, VectorByPointProduct< Lhs, Rhs > > log () const
 
UnaryOperator< SqrtOp< Type >, VectorByPointProduct< Lhs, Rhs > > sqrt () const
 
UnaryOperator< CosOp< Type >, VectorByPointProduct< Lhs, Rhs > > cos () const
 
UnaryOperator< SinOp< Type >, VectorByPointProduct< Lhs, Rhs > > sin () const
 
UnaryOperator< AcosOp< Type >, VectorByPointProduct< Lhs, Rhs > > acos () const
 
UnaryOperator< AsinOp< Type >, VectorByPointProduct< Lhs, Rhs > > asin () const
 
UnaryOperator< TanOp< Type >, VectorByPointProduct< Lhs, Rhs > > tan () const
 
UnaryOperator< InverseOp< Type >, VectorByPointProduct< Lhs, Rhs > > inverse () const
 
UnaryOperator< SquareOp< Type >, VectorByPointProduct< Lhs, Rhs > > square () const
 
UnaryOperator< CubeOp< Type >, VectorByPointProduct< Lhs, Rhs > > cube () const
 
UnaryOperator< ProductWithOp< Type >, VectorByPointProduct< Lhs, Rhs > > operator* (Type const &value) const
 
hidden::ProductSelector< VectorByPointProduct< Lhs, Rhs >, Rhs, hidden::Traits< VectorByPointProduct< Lhs, Rhs > >::structure_, hidden::Traits< Rhs >::structure_ >::ProductType const operator* (ExprBase< Rhs > const &other) const
 
UnaryOperator< PowOp< Type >, VectorByPointProduct< Lhs, Rhs > > pow (Type const &value) const
 
UnaryOperator< SafeInverseOp< Type >, VectorByPointProduct< Lhs, Rhs > > safeInverse (Type const &value) const
 
UnaryOperator< SafeOp< Type >, VectorByPointProduct< Lhs, Rhs > > const safe (Type const value=Type()) const
 
UnaryOperator< CastOp< Type, OtherType >, VectorByPointProduct< Lhs, Rhs > > const cast () const
 
UnaryOperator< Law::PdfOp< Type >, VectorByPointProduct< Lhs, Rhs > > pdf (Law::IUnivLaw< Type > const &law) const
 compute pdf values to this using distribution law given by user
 
UnaryOperator< Law::LogPdfOp< Type >, VectorByPointProduct< Lhs, Rhs > > lpdf (Law::IUnivLaw< Type > const &law) const
 compute log-pdf values to this using distribution law given by user
 
UnaryOperator< Law::CdfOp< Type >, VectorByPointProduct< Lhs, Rhs > > cdf (Law::IUnivLaw< Type > const &law) const
 compute cumulative distribution function of this using distribution law given by user
 
UnaryOperator< Law::LogCdfOp< Type >, VectorByPointProduct< Lhs, Rhs > > lcdf (Law::IUnivLaw< Type > const &law) const
 compute log-cumulative distribution function of this using distribution law given by user
 
UnaryOperator< Law::CdfcOp< Type >, VectorByPointProduct< Lhs, Rhs > > cdfc (Law::IUnivLaw< Type > const &law) const
 compute complementary cumulative distribution function of this using distribution law given by user
 
UnaryOperator< Law::LogCdfcOp< Type >, VectorByPointProduct< Lhs, Rhs > > lcdfc (Law::IUnivLaw< Type > const &law) const
 compute complementary cumulative distribution function of this using distribution law given by user
 
UnaryOperator< Law::IcdfOp< Type >, VectorByPointProduct< Lhs, Rhs > > icdf (Law::IUnivLaw< Type > const &law) const
 compute inverse cumulative distribution function using distribution law given by user
 
UnaryOperator< OtherOperator< Type >, VectorByPointProduct< Lhs, Rhs > > const funct0 () const
 
UnaryOperator< OtherOperator< Type >, VectorByPointProduct< Lhs, Rhs > > const funct1 (Type const value) const
 
TransposeOperator< VectorByPointProduct< Lhs, Rhs > > const transpose () const
 
DiagonalizeOperator< VectorByPointProduct< Lhs, Rhs > > const diagonalize () const
 
DiagonalGetterOperator< VectorByPointProduct< Lhs, Rhs > > const getDiagonal () const
 
UpperTriangularizeOperator< VectorByPointProduct< Lhs, Rhs > > const upperTriangularize () const
 
LowerTriangularizeOperator< VectorByPointProduct< Lhs, Rhs > > const lowerTriangularize () const
 
SymmetrizeOperator< VectorByPointProduct< Lhs, Rhs > > const symmetrize () const
 
UpperSymmetrizeOperator< VectorByPointProduct< Lhs, Rhs > > const upperSymmetrize () const
 
LowerSymmetrizeOperator< VectorByPointProduct< Lhs, Rhs > > const lowerSymmetrize () const
 
SubVectorOperator< VectorByPointProduct< Lhs, Rhs >, Size_ > const sub (TRange< Size_ > const &I) const
 
SubOperator< VectorByPointProduct< Lhs, Rhs >, SizeRows_, SizeCols_ > const sub (TRange< SizeRows_ > const &I, TRange< SizeCols_ > const &J) const
 
ColOperator< VectorByPointProduct< Lhs, Rhs > > const col (int j) const
 
SubOperator< VectorByPointProduct< Lhs, Rhs >, sizeRows_, Size_ > const col (TRange< Size_ > const &J) const
 
RowOperator< VectorByPointProduct< Lhs, Rhs > > const row (int i) const
 
SubOperator< VectorByPointProduct< Lhs, Rhs >, Size_, sizeCols_ > const row (TRange< Size_ > const &I) 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
 

Protected Attributes

Lhs constlhs_
 
Rhs constrhs_
 

Additional Inherited Members

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

Detailed Description

template<typename Lhs, typename Rhs>
class STK::VectorByPointProduct< Lhs, Rhs >

Generic expression where a product operator is applied to two expressions.

Template Parameters
Lhsleft-hand side type
Rhsright-hand side type

This class represents an expression where a product operator is applied to two expressions.

It is the return type of product operator when the left hand side expression is a (column) vector and the right and side expression is a point (a row vector).

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

Template Parameters
Lhsthe type of the left-hand side, a vector expression
Rhsthe type of the right-hand side, a row-vector expression

This class represents an expression where a product operator is applied to two expressions. The left hand Side is a vector expression, the Right Hand Side is a row-vector expression.

Definition at line 360 of file STK_ProductOperators.h.

Member Typedef Documentation

◆ Base

◆ ColRange

Type of the Range for the columns.

Definition at line 379 of file STK_ProductOperators.h.

◆ RowRange

Type of the Range for the rows.

Definition at line 377 of file STK_ProductOperators.h.

◆ Type

◆ TypeConst

Definition at line 366 of file STK_ProductOperators.h.

Member Enumeration Documentation

◆ anonymous enum

Enumerator
structure_ 
orient_ 
sizeRows_ 
sizeCols_ 
storage_ 

Definition at line 368 of file STK_ProductOperators.h.

369 {
370 structure_ = hidden::Traits<VectorByPointProduct>::structure_,
371 orient_ = hidden::Traits<VectorByPointProduct>::orient_,
372 sizeRows_ = hidden::Traits<VectorByPointProduct>::sizeRows_,
373 sizeCols_ = hidden::Traits<VectorByPointProduct>::sizeCols_,
374 storage_ = hidden::Traits<VectorByPointProduct>::storage_
375 };

Constructor & Destructor Documentation

◆ VectorByPointProduct()

template<typename Lhs , typename Rhs >
STK::VectorByPointProduct< Lhs, Rhs >::VectorByPointProduct ( const Lhs lhs,
const Rhs rhs 
)
inline

constructor

Definition at line 382 of file STK_ProductOperators.h.

382: Base(), lhs_(lhs), rhs_(rhs){}
ExprBase< VectorByPointProduct< Lhs, Rhs > > Base

Member Function Documentation

◆ colsImpl()

template<typename Lhs , typename Rhs >
ColRange const & STK::VectorByPointProduct< Lhs, Rhs >::colsImpl ( ) const
inline
Returns
the columns range

Definition at line 386 of file STK_ProductOperators.h.

386{ return rhs_.cols();}

References STK::VectorByPointProduct< Lhs, Rhs >::rhs_.

◆ elt0Impl()

template<typename Lhs , typename Rhs >
TypeConst STK::VectorByPointProduct< Lhs, Rhs >::elt0Impl ( ) const
inline
Returns
the element

Definition at line 391 of file STK_ProductOperators.h.

391{ return lhs_.elt()*rhs_.elt();}

References STK::VectorByPointProduct< Lhs, Rhs >::lhs_, and STK::VectorByPointProduct< Lhs, Rhs >::rhs_.

◆ elt2Impl()

template<typename Lhs , typename Rhs >
TypeConst STK::VectorByPointProduct< Lhs, Rhs >::elt2Impl ( int  i,
int  j 
) const
inline
Returns
the element (i,j)

Definition at line 389 of file STK_ProductOperators.h.

389{ return lhs_.elt(i)*rhs_.elt(j);}

References STK::VectorByPointProduct< Lhs, Rhs >::lhs_, and STK::VectorByPointProduct< Lhs, Rhs >::rhs_.

◆ lhs()

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

Definition at line 394 of file STK_ProductOperators.h.

394{ return lhs_; }

References STK::VectorByPointProduct< Lhs, Rhs >::lhs_.

◆ rhs()

template<typename Lhs , typename Rhs >
Rhs const & STK::VectorByPointProduct< Lhs, Rhs >::rhs ( ) const
inline
Returns
the right hand side expression

Definition at line 396 of file STK_ProductOperators.h.

396{ return rhs_; }

References STK::VectorByPointProduct< Lhs, Rhs >::rhs_.

◆ rowsImpl()

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

Definition at line 384 of file STK_ProductOperators.h.

384{ return lhs_.rows();}

References STK::VectorByPointProduct< Lhs, Rhs >::lhs_.

Member Data Documentation

◆ lhs_

◆ rhs_


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