VectorOperationsDefault.h

Go to the documentation of this file.

#ifndef included_AMP_VectorOperationsDefault
#define included_AMP_VectorOperationsDefault
 
 
#include "AMP/vectors/operations/VectorOperations.h"
 
 
namespace AMP::LinearAlgebra {
 
 
template<typename TYPE = double>
class VectorOperationsDefault : public VectorOperations
{
public:
    // Constructor
    VectorOperationsDefault() {}
 
    virtual ~VectorOperationsDefault() {}
 
    std::shared_ptr<VectorOperations> cloneOperations() const override;
 
public:
    //  function that operate on VectorData
    std::string VectorOpName() const override;
    void copy( const VectorData &x, VectorData &z ) override;
    void copyCast( const VectorData &x, VectorData &z ) override;
    void zero( VectorData &z ) override;
    void setToScalar( const Scalar &alpha, VectorData &z ) override;
    void setRandomValues( VectorData &x ) override;
    void scale( const Scalar &alpha, const VectorData &x, VectorData &y ) override;
    void scale( const Scalar &alpha, VectorData &x ) override;
    void add( const VectorData &x, const VectorData &y, VectorData &z ) override;
    void subtract( const VectorData &x, const VectorData &y, VectorData &z ) override;
    void multiply( const VectorData &x, const VectorData &y, VectorData &z ) override;
    void divide( const VectorData &x, const VectorData &y, VectorData &z ) override;
    void reciprocal( const VectorData &x, VectorData &y ) override;
    void linearSum( const Scalar &alpha,
                    const VectorData &x,
                    const Scalar &beta,
                    const VectorData &y,
                    VectorData &z ) override;
    void
    axpy( const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z ) override;
    void
    axpby( const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y ) override;
    void abs( const VectorData &x, VectorData &z ) override;
    void addScalar( const VectorData &x, const Scalar &alpha, VectorData &y ) override;
 
    void setMax( const Scalar &val, VectorData &x ) override;
    void setMin( const Scalar &val, VectorData &x ) override;
 
    Scalar localMin( const VectorData &x ) const override;
    Scalar localMax( const VectorData &x ) const override;
    Scalar localSum( const VectorData & ) const override;
    Scalar localL1Norm( const VectorData &x ) const override;
    Scalar localL2Norm( const VectorData &x ) const override;
    Scalar localMaxNorm( const VectorData &x ) const override;
    Scalar localDot( const VectorData &x, const VectorData &y ) const override;
    Scalar localMinQuotient( const VectorData &x, const VectorData &y ) const override;
    Scalar localWrmsNorm( const VectorData &x, const VectorData &y ) const override;
    Scalar localWrmsNormMask( const VectorData &x,
                              const VectorData &mask,
                              const VectorData &y ) const override;
    bool localEquals( const VectorData &x,
                      const VectorData &y,
                      const Scalar &tol = 0.000001 ) const override;
 
public: // Pull VectorOperations into the current scope
    using VectorOperations::abs;
    using VectorOperations::add;
    using VectorOperations::addScalar;
    using VectorOperations::axpby;
    using VectorOperations::axpy;
    using VectorOperations::divide;
    using VectorOperations::dot;
    using VectorOperations::equals;
    using VectorOperations::L1Norm;
    using VectorOperations::L2Norm;
    using VectorOperations::linearSum;
    using VectorOperations::localL1Norm;
    using VectorOperations::localL2Norm;
    using VectorOperations::localMaxNorm;
    using VectorOperations::max;
    using VectorOperations::maxNorm;
    using VectorOperations::min;
    using VectorOperations::minQuotient;
    using VectorOperations::multiply;
    using VectorOperations::reciprocal;
    using VectorOperations::scale;
    using VectorOperations::setMax;
    using VectorOperations::setMin;
    using VectorOperations::setRandomValues;
    using VectorOperations::subtract;
    using VectorOperations::wrmsNorm;
    using VectorOperations::wrmsNormMask;
 
public: // Write/read restart data
    void registerChildObjects( AMP::IO::RestartManager *manager ) const override;
    void writeRestart( int64_t fid ) const override;
    VectorOperationsDefault( int64_t fid, AMP::IO::RestartManager *manager );
};
 
 
} // namespace AMP::LinearAlgebra
 
 
#endif