/home/marsyas/marsyas/src/marsyas/realvec.h

/*
** Copyright (C) 1998-2010 George Tzanetakis <gtzan@cs.uvic.ca>
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef MARSYAS_REALVEC_H
#define MARSYAS_REALVEC_H

#include <cmath>
#include <cfloat>
#include <cstring>
#include <string>
#include <iostream>
#include <fstream>
#include <stdexcept>


#include "common_header.h" 
#include "MrsLog.h"
#include "Communicator.h"

namespace Marsyas
{
    class marsyas_EXPORT realvec
    {

      public:
        realvec();
        realvec(mrs_natural size);
        realvec(mrs_natural rows, mrs_natural cols);
        realvec(const realvec& a);
        ~realvec(); // not mean to be inherited from

        realvec& operator=(const realvec& a);

        void allocate(mrs_natural size);
        void allocate(mrs_natural rows, mrs_natural cols);

        void create(mrs_natural size);
        void create(mrs_natural rows, mrs_natural cols);
        void create(mrs_real val, mrs_natural rows, mrs_natural cols);

        void stretch(mrs_natural rows, mrs_natural cols);
        void stretch(mrs_natural size);

        void stretchWrite(const mrs_natural pos, const mrs_real val);
        void stretchWrite(const mrs_natural r, const mrs_natural c, const mrs_real val);


        void setval(mrs_natural start, mrs_natural end, mrs_real val);
        void setval(mrs_real val);
        void appendRealvec(const realvec newValues);


        void apply(mrs_real (*func) (mrs_real));

        mrs_natural getSize() const;
        mrs_natural getCols() const;
        mrs_natural getRows() const;
        realvec getSubVector(mrs_natural startPos, mrs_natural length) const;
        mrs_real *getData() const;


        void shuffle();

        realvec& operator+=(const realvec& vec);
        realvec& operator-=(const realvec& vec);
        realvec& operator*=(const realvec& vec);
        realvec& operator/=(const realvec& vec);
        realvec& operator*=(const mrs_real val);
        realvec& operator/=(const mrs_real val);
        realvec& operator+=(const mrs_real val);
        realvec& operator-=(const mrs_real val);

        marsyas_EXPORT friend realvec operator+(const realvec& vec1, const realvec& vec2);
        marsyas_EXPORT friend realvec operator-(const realvec& vec1, const realvec& vec2);
        marsyas_EXPORT friend realvec operator*(const realvec& vec1, const realvec& vec2);
        marsyas_EXPORT friend realvec operator/(const realvec& vec1, const realvec& vec2);
    
        bool operator!=(const realvec& v1) const;
        bool operator==(const realvec &v1) const;
    


    
        mrs_real& operator()(const mrs_natural i);
        mrs_real operator()(const mrs_natural i) const;
        mrs_real& operator()(const mrs_natural r, const mrs_natural c);
        mrs_real operator()(const mrs_natural r, const mrs_natural c) const;

        mrs_real getValueFenced(const mrs_natural i) const;
        mrs_real getValueFenced(const mrs_natural r, const mrs_natural c) const;
        mrs_real& getValueFenced(const mrs_natural i);
        mrs_real& getValueFenced(const mrs_natural r, const mrs_natural c);





        realvec operator()(std::string r, std::string c);
        realvec operator()(std::string r);
        void getRow(const mrs_natural r, realvec& res) const;
        void getCol(const mrs_natural c, realvec& res) const;
        void getSubMatrix (const mrs_natural r, const mrs_natural c, realvec& res);
        // set row in matrix
        void setRow (const mrs_natural r, const realvec src);
        // set col in matrix
        void setCol (const mrs_natural c, const realvec src);
        // set submatrix
        void setSubMatrix (const mrs_natural r, const mrs_natural c, const realvec src) ;

        void debug_info();
        void dump();
        bool write(std::string filename) const;
        bool read(std::string filename);

        void dumpDataOnly(std::ostream& o=std::cout, std::string columnSep=" ", std::string rowSep="\n") const;

        marsyas_EXPORT friend std::ostream& operator<<(std::ostream&, const realvec&);
        marsyas_EXPORT friend std::istream& operator>>(std::istream&, realvec&);
        bool readText(std::string filename);
        bool writeText(std::string filename);

        void meanObs(realvec& res) const;
        void stdObs(realvec& res) const;
        void varObs(realvec& res) const;
        void normObs();
        void normSpl(mrs_natural=0);
        void normObsMinMax();
        void normSplMinMax(mrs_natural=0);

        mrs_real maxval(mrs_natural *index=NULL) const;
        mrs_real minval() const;
        mrs_real mean() const;
        mrs_real median() const;
        mrs_real sum() const;
        mrs_real std() const;
        mrs_real var() const;
        void sort();//non-descending sort - assumes one dimensional vector only!
        void abs();
        void sqr();
        void sqroot();
        void norm();
        void normMaxMin();
        void pow (mrs_real exp);

        static void matrixMulti(const mrs_realvec& a,const mrs_realvec& b,mrs_realvec& out);
        void norm(mrs_real mean, mrs_real std);
        void renorm(mrs_real old_mean, mrs_real old_std, mrs_real new_mean, mrs_real new_std);
        mrs_natural invert(realvec& res);//lmartins: this seems to be both inplace and returning the inverse matrix in "res"... why both?!? [!][?]
        void transpose();
        void fliplr ();
        void flipud ();
        void covariance(realvec& res) const; //Typical covariance calculation, as performed by MATLAB cov().
        void covariance2(realvec& res) const;//Marsyas0.1 covariance calculation (assumes standardized data, and uses biased estimation)
        void correlation(realvec& res) const;
        mrs_real trace() const;
        mrs_real det() const;

        void send(Communicator *com);
        mrs_natural search(mrs_real val);
    

      private:
        void allocateData(mrs_natural size);
        mrs_natural  size_;
        mrs_natural allocatedSize_;
        mrs_real *data_;
        mrs_natural rows_;
        mrs_natural cols_;
    

    
    };
    
    inline
    mrs_real realvec::operator()(const mrs_natural r, const mrs_natural c) const
    {
        
        MRSASSERT(r < rows_);
        MRSASSERT(c < cols_);
        
        return data_[c * rows_ + r];
    }
    
    inline
    mrs_real& realvec::operator()(const mrs_natural r, const mrs_natural c)
    {
        MRSASSERT(r < rows_);
        MRSASSERT(c < cols_);
        MRSASSERT(r >= 0);
        MRSASSERT(c >= 0);
        
        return data_[c * rows_ + r];
    }
    
    
    inline 
    mrs_real realvec::operator()(const mrs_natural i) const
    {
        MRSASSERT(i < size_);
        return data_[i];
    }
    
    
    inline 
    mrs_real& realvec::operator()(const mrs_natural i)
    {
        
        MRSASSERT(i < size_);
        return data_[i];
    }


    


}//namespace Marsyas


#endif /* !MARSYAS_REALVEC_H */

---