VectorOperations.h

Go to the documentation of this file.

#ifndef included_AMP_VectorOperations
#define included_AMP_VectorOperations
 
#include "AMP/vectors/Scalar.h"
 
#include <memory>
#include <vector>
 
 
namespace AMP::IO {
class RestartManager;
}
 
 
namespace AMP::LinearAlgebra {
 
 
class VectorData;
 
 
class VectorOperations
{
public:
    virtual ~VectorOperations() {}
 
    virtual std::string VectorOpName() const = 0;
 
    virtual std::shared_ptr<VectorOperations> cloneOperations() const = 0;
 
    // VectorData versions
    virtual void copy( const VectorData &x, VectorData &z ) = 0;
 
    virtual void copyCast( const VectorData &x, VectorData &z ) = 0;
 
    virtual void zero( VectorData &x ) = 0;
 
    virtual void setToScalar( const Scalar &alpha, VectorData &z ) = 0;
 
    virtual void setRandomValues( VectorData &x ) = 0;
 
    virtual void scale( const Scalar &alpha, const VectorData &x, VectorData &y ) = 0;
 
    virtual void scale( const Scalar &alpha, VectorData &x ) = 0;
 
    virtual void add( const VectorData &x, const VectorData &y, VectorData &z ) = 0;
 
    virtual void subtract( const VectorData &x, const VectorData &y, VectorData &z ) = 0;
 
    virtual void multiply( const VectorData &x, const VectorData &y, VectorData &z ) = 0;
 
    virtual void divide( const VectorData &x, const VectorData &y, VectorData &z ) = 0;
 
    virtual void reciprocal( const VectorData &x, VectorData &y ) = 0;
 
    virtual void linearSum( const Scalar &alpha,
                            const VectorData &x,
                            const Scalar &beta,
                            const VectorData &y,
                            VectorData &z ) = 0;
 
    virtual void
    axpy( const Scalar &alpha, const VectorData &x, const VectorData &y, VectorData &z ) = 0;
 
    virtual void
    axpby( const Scalar &alpha, const Scalar &beta, const VectorData &x, VectorData &y ) = 0;
 
    virtual void abs( const VectorData &x, VectorData &z ) = 0;
 
    virtual void addScalar( const VectorData &x, const Scalar &alpha, VectorData &y ) = 0;
 
    virtual void setMax( const Scalar &val, VectorData &x ) = 0;
 
    virtual void setMin( const Scalar &val, VectorData &x ) = 0;
 
    virtual Scalar min( const VectorData &x ) const;
 
    virtual Scalar max( const VectorData &x ) const;
 
    virtual Scalar sum( const VectorData &x ) const;
 
    Scalar mean( const VectorData &x ) const;
 
    virtual Scalar L1Norm( const VectorData &x ) const;
 
    virtual Scalar L2Norm( const VectorData &x ) const;
 
    virtual Scalar maxNorm( const VectorData &x ) const;
    virtual Scalar minQuotient( const VectorData &x, const VectorData &y ) const;
 
    virtual Scalar wrmsNorm( const VectorData &x, const VectorData &y ) const;
 
    virtual Scalar
    wrmsNormMask( const VectorData &x, const VectorData &mask, const VectorData &y ) const;
 
    virtual Scalar dot( const VectorData &x, const VectorData &y ) const;
 
    virtual bool equals( const VectorData &x, const VectorData &y, const Scalar &tol ) const;
 
    virtual Scalar localMin( const VectorData &x ) const = 0;
 
    virtual Scalar localMax( const VectorData &x ) const = 0;
 
    virtual Scalar localSum( const VectorData &x ) const = 0;
 
    virtual Scalar localL1Norm( const VectorData &x ) const = 0;
 
    virtual Scalar localL2Norm( const VectorData &x ) const = 0;
 
    virtual Scalar localMaxNorm( const VectorData &x ) const = 0;
 
    virtual Scalar localDot( const VectorData &x, const VectorData &y ) const = 0;
 
    virtual Scalar localMinQuotient( const VectorData &x, const VectorData &y ) const = 0;
 
    virtual Scalar localWrmsNorm( const VectorData &x, const VectorData &y ) const = 0;
 
    virtual Scalar
    localWrmsNormMask( const VectorData &x, const VectorData &mask, const VectorData &y ) const = 0;
 
    virtual bool
    localEquals( const VectorData &x, const VectorData &y, const Scalar &tol = 1e-6 ) const = 0;
 
 
    uint64_t getID() const;
 
 
public: // Write/read restart data
    virtual void registerChildObjects( AMP::IO::RestartManager *manager ) const;
 
    virtual void writeRestart( int64_t fid ) const;
 
 
protected:
    VectorOperations();
 
protected:
    uint64_t d_hash = 0;
};
 
 
} // namespace AMP::LinearAlgebra
 
#endif