SG++-Doxygen-Documentation
sgpp::combigrid::FloatScalarVector Class Reference

This class models a single scalar supporting operations such as addition, scalar multiplication and componentwise muliplication. More...

#include <FloatScalarVector.hpp>

Public Member Functions

void add (FloatScalarVector const &other)
 
void componentwiseMult (FloatScalarVector const &other)
 
 FloatScalarVector ()
 
 FloatScalarVector (double const &value)
 
 FloatScalarVector (std::shared_ptr< TreeStorage< FloatScalarVector >> storage)
 
 FloatScalarVector (FloatScalarVector const &other)
 
double getValue () const
 
double norm () const
 
FloatScalarVectoroperator= (FloatScalarVector const &other)
 
FloatScalarVectoroperator= (double const &value)
 
FloatScalarVector const operator[] (size_t i) const
 
void scalarMult (double const &factor)
 
void sub (FloatScalarVector const &other)
 
double const & value () const
 
double & value ()
 

Static Public Member Functions

static FloatScalarVector one ()
 
static FloatScalarVector zero ()
 

Detailed Description

This class models a single scalar supporting operations such as addition, scalar multiplication and componentwise muliplication.

It is intended to have the same interface as FloatArrayVector. Thus, one can use the same code for single-evaluation and multi-evaluation, where the mode is controlled by passing FloatArrayVector or FloatScalarVector as a template parameter.

Constructor & Destructor Documentation

◆ FloatScalarVector() [1/4]

sgpp::combigrid::FloatScalarVector::FloatScalarVector ( )
inline

Referenced by one(), and zero().

◆ FloatScalarVector() [2/4]

sgpp::combigrid::FloatScalarVector::FloatScalarVector ( double const &  value)
inlineexplicit

◆ FloatScalarVector() [3/4]

sgpp::combigrid::FloatScalarVector::FloatScalarVector ( std::shared_ptr< TreeStorage< FloatScalarVector >>  storage)
inlineexplicit

◆ FloatScalarVector() [4/4]

sgpp::combigrid::FloatScalarVector::FloatScalarVector ( FloatScalarVector const &  other)
inline

Member Function Documentation

◆ add()

void sgpp::combigrid::FloatScalarVector::add ( FloatScalarVector const &  other)
inline

◆ componentwiseMult()

void sgpp::combigrid::FloatScalarVector::componentwiseMult ( FloatScalarVector const &  other)
inline

◆ getValue()

◆ norm()

double sgpp::combigrid::FloatScalarVector::norm ( ) const
inline

◆ one()

static FloatScalarVector sgpp::combigrid::FloatScalarVector::one ( )
inlinestatic

References FloatScalarVector().

◆ operator=() [1/2]

FloatScalarVector& sgpp::combigrid::FloatScalarVector::operator= ( FloatScalarVector const &  other)
inline

◆ operator=() [2/2]

FloatScalarVector& sgpp::combigrid::FloatScalarVector::operator= ( double const &  value)
inline

References value().

◆ operator[]()

FloatScalarVector const sgpp::combigrid::FloatScalarVector::operator[] ( size_t  i) const
inline

◆ scalarMult()

void sgpp::combigrid::FloatScalarVector::scalarMult ( double const &  factor)
inline

◆ sub()

void sgpp::combigrid::FloatScalarVector::sub ( FloatScalarVector const &  other)
inline

◆ value() [1/2]

◆ value() [2/2]

double& sgpp::combigrid::FloatScalarVector::value ( )
inline

◆ zero()

static FloatScalarVector sgpp::combigrid::FloatScalarVector::zero ( )
inlinestatic

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