optmatrix.h

/*
 * The GURLS Package in C++
 *
 * Copyright (C) 2011-1013, IIT@MIT Lab
 * All rights reserved.
 *
 * authors:  M. Santoro
 * email:   msantoro@mit.edu
 * website: http://cbcl.mit.edu/IIT@MIT/IIT@MIT.html
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *     * Redistributions of source code must retain the above
 *       copyright notice, this list of conditions and the following
 *       disclaimer.
 *     * Redistributions in binary form must reproduce the above
 *       copyright notice, this list of conditions and the following
 *       disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *     * Neither the name(s) of the copyright holders nor the names
 *       of its contributors or of the Massacusetts Institute of
 *       Technology or of the Italian Institute of Technology may be
 *       used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


#ifndef _GURLS_OPTMATRIX_H_
#define _GURLS_OPTMATRIX_H_

#include <gurls++/options.h>

#ifdef _BGURLS
#include <bgurls++/bigarray.h>
#endif

namespace gurls
{

class GURLS_EXPORT OptMatrixBase: public GurlsOption
{
public:

    OptMatrixBase(): GurlsOption(MatrixOption){}

    enum MatrixType{FLOAT, DOUBLE, ULONG};

    MatrixType getMatrixType() const
    {
        return matType;
    }

#ifdef _BGURLS

    virtual bool hasBigArray() const = 0;
#endif


protected:
    MatrixType matType; 
};


template<class Matrix>
OptMatrixBase::MatrixType getMatrixCellType()
{
    throw gException(Exception_Unsupported_MatrixType);
}

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<gMat2D<float> >();

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<gMat2D<double> >();

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<const gMat2D<float> >();

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<const gMat2D<double> >();

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<gMat2D<unsigned long> >();

#ifdef _BGURLS

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<BigArray<float> >();

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<BigArray<double> >();

template<>
GURLS_EXPORT OptMatrixBase::MatrixType getMatrixCellType<BigArray<unsigned long> >();

#endif


template <typename Matrix>
class OptMatrix: public OptMatrixBase
{
private:
    Matrix* value;  
    bool isOwner;   

public:
    typedef Matrix ValueType;

    OptMatrix(): OptMatrixBase () , value (new Matrix()), isOwner(true)
    {
        this->matType = getMatrixCellType<Matrix>();
    }

    OptMatrix(Matrix& m, bool owner = true): OptMatrixBase(), value(&m), isOwner(owner)
    {
        this->matType = getMatrixCellType<Matrix>();
    }

    OptMatrix<Matrix>& operator=(const OptMatrix<Matrix>& other);

    ~OptMatrix()
    {
        if(isOwner)
            delete value;
    }

    void detachValue()
    {
        isOwner = false;
    }

    OptMatrix& operator=(const Matrix& other)
    {
        setValue(other);

        this->type = MatrixOption;

        return *this;
    }

    void setValue(const Matrix& newvalue)
    {
        ~OptMatrix();

        value = new Matrix(newvalue);
        this->isOwner = true;
    }

    Matrix& getValue()
    {
        return *value;
    }

    const Matrix& getValue() const
    {
        return *value;
    }

    virtual bool isA(OptTypes id) const
    {
        return (id == MatrixOption);
    }

#ifdef _BGURLS

    virtual bool hasBigArray() const
    {
        return false;
    }
#endif

    static OptMatrix* dynacast(GurlsOption* opt)
    {
        if (opt->isA(MatrixOption) )
            return static_cast<OptMatrix*>(opt);

        throw gException(gurls::Exception_Illegal_Dynamic_Cast);
    }

    static const OptMatrix* dynacast(const GurlsOption* opt)
    {
        if (opt->isA(MatrixOption) )
            return static_cast<const OptMatrix*>(opt);

        throw gException(gurls::Exception_Illegal_Dynamic_Cast);
    }

    virtual std::ostream& operator<<(std::ostream& os) const;

};

#ifdef _BGURLS

template <>
bool OptMatrix<BigArray<float> >::hasBigArray() const{return true;};

template <>
bool OptMatrix <BigArray<double> >::hasBigArray() const{return true;};

template <>
bool OptMatrix <BigArray<unsigned long> >::hasBigArray() const{return true;};

#endif


template <typename T>
std::ostream& OptMatrix<T>::operator << (std::ostream& os) const
{
    return os << std::endl << this->getValue();
}

}

#endif //_GURLS_OPTMATRIX_H_