Vector.h

 
// Description: A simple, parallel Vector class with the utility needed to
//              support the basis generation methods of this library.  A
//              distributed Vector has its rows distributed across processors.
 
#ifndef included_Vector_h
#define included_Vector_h
 
#include "utils/Utilities.h"
#include <vector>
#include <functional>
 
namespace CAROM {
 
class Vector
{
public:
    Vector();
 
    Vector(
        int dim,
        bool distributed);
 
    Vector(
        double* vec,
        int dim,
        bool distributed,
        bool copy_data = true);
 
    Vector(
        const Vector& other);
 
    ~Vector();
 
    Vector&
    operator = (
        const Vector& rhs);
 
    Vector&
    operator += (
        const Vector& rhs);
 
    Vector&
    operator -= (
        const Vector& rhs);
 
    Vector&
    operator = (
        const double& a);
 
    Vector&
    operator *= (
        const double& a);
 
    Vector&
    transform(std::function<void(const int size, double* vector)> transformer);
 
    void
    transform(Vector& result,
              std::function<void(const int size, double* vector)> transformer) const;
 
    void
    transform(Vector*& result,
              std::function<void(const int size, double* vector)> transformer) const;
 
    Vector&
    transform(
        std::function<void(const int size, double* origVector, double* resultVector)>
        transformer);
 
    void
    transform(Vector& result,
              std::function<void(const int size, double* origVector, double* resultVector)>
              transformer) const;
 
    void
    transform(Vector*& result,
              std::function<void(const int size, double* origVector, double* resultVector)>
              transformer) const;
 
    void
    setSize(
        int dim)
    {
        if (dim > d_alloc_size) {
            if (!d_owns_data) {
                CAROM_ERROR("Can not reallocate externally owned storage.");
            }
            if (d_vec) {
                delete [] d_vec;
            }
 
            // Allocate new array and initialize all values to zero.
            d_vec = new double [dim] {0.0};
            d_alloc_size = dim;
        }
        d_dim = dim;
    }
 
    bool
    distributed() const
    {
        return d_distributed;
    }
 
    int
    dim() const
    {
        return d_dim;
    }
 
    double
    inner_product(
        const Vector& other) const;
 
    double
    inner_product(
        const Vector* other) const
    {
        CAROM_VERIFY(other != 0);
        return inner_product(*other);
    }
 
    double
    norm() const;
 
    double
    norm2() const;
 
    double
    normalize();
 
    Vector*
    plus(
        const Vector& other) const
    {
        Vector* result = 0;
        plus(other, result);
        return result;
    }
 
    Vector*
    plus(
        const Vector* other) const
    {
        CAROM_VERIFY(other != 0);
        return plus(*other);
    }
 
    void
    plus(
        const Vector& other,
        Vector*& result) const;
 
    void
    plus(
        const Vector& other,
        Vector& result) const;
 
    Vector*
    plusAx(
        double factor,
        const Vector& other)
    {
        Vector* result = 0;
        plusAx(factor, other, result);
        return result;
    }
 
    Vector*
    plusAx(
        double factor,
        const Vector* other)
    {
        CAROM_VERIFY(other != 0);
        return plusAx(factor, *other);
    }
 
    void
    plusAx(
        double factor,
        const Vector& other,
        Vector*& result) const;
 
    void
    plusAx(
        double factor,
        const Vector& other,
        Vector& result) const;
 
    void
    plusEqAx(
        double factor,
        const Vector& other);
 
    void
    plusEqAx(
        double factor,
        const Vector* other)
    {
        CAROM_VERIFY(other != 0);
        plusEqAx(factor, *other);
    }
 
    Vector*
    minus(
        const Vector& other) const
    {
        Vector* result = 0;
        minus(other, result);
        return result;
    }
 
    Vector*
    minus(
        const Vector* other) const
    {
        CAROM_VERIFY(other != 0);
        return minus(*other);
    }
 
    void
    minus(
        const Vector& other,
        Vector*& result) const;
 
    void
    minus(
        const Vector& other,
        Vector& result) const;
 
    Vector*
    mult(
        double factor) const
    {
        Vector* result = 0;
        mult(factor, result);
        return result;
    }
 
    void
    mult(
        double factor,
        Vector*& result) const;
 
    void
    mult(
        double factor,
        Vector& result) const;
 
    const double&
    item(
        int i) const
    {
        CAROM_ASSERT((0 <= i) && (i < dim()));
        return d_vec[i];
    }
 
    double&
    item(
        int i)
    {
        CAROM_ASSERT((0 <= i) && (i < dim()));
        return d_vec[i];
    }
 
    const double& operator() (int i) const
    {
        return item(i);
    }
 
    double& operator() (int i)
    {
        return item(i);
    }
 
    void print(const char * prefix) const;
 
    void write(const std::string& base_file_name);
 
    void read(const std::string& base_file_name);
 
    void local_read(const std::string& base_file_name, int rank);
 
    double *getData() const
    {
        return d_vec;
    }
 
    double localMin(int nmax = 0);
 
    void distribute(const int local_dim);
 
    void gather();
 
private:
    double* d_vec;
 
    int d_dim;
 
    int d_alloc_size;
 
    bool d_distributed;
 
    int d_num_procs;
 
    int d_rank;
 
    bool d_owns_data;
};
 
int getCenterPoint(std::vector<Vector*>& points,
                   bool use_centroid);
 
int getCenterPoint(std::vector<Vector>& points,
                   bool use_centroid);
 
int getClosestPoint(std::vector<Vector*>& points,
                    Vector* test_point);
 
int getClosestPoint(std::vector<Vector>& points,
                    Vector test_point);
}
 
#endif