Array2.h

Go to the documentation of this file.

/*
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * Written (W) 1999-2009 Soeren Sonnenburg, Gunnar Raetsch
 * Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _ARRAY2_H_
#define _ARRAY2_H_

#include <shogun/lib/common.h>
#include <shogun/base/SGObject.h>
#include <shogun/lib/Array.h>

namespace shogun
{
template <class T> class CArray2;

template <class T> class CArray2: public CArray<T>
{
    public:
        CArray2(int32_t dim1=1, int32_t dim2=1)
        : CArray<T>(dim1*dim2), dim1_size(dim1), dim2_size(dim2)
        {
        }

        CArray2(T* p_array, int32_t dim1, int32_t dim2, bool p_free_array=true, bool p_copy_array=false)
        : CArray<T>(p_array, dim1*dim2, p_free_array, p_copy_array),
            dim1_size(dim1), dim2_size(dim2)
        {
        }

        CArray2(const T* p_array, int32_t dim1, int32_t dim2)
        : CArray<T>(p_array, dim1*dim2), dim1_size(dim1), dim2_size(dim2)
        {
        }

        virtual ~CArray2() {}

        inline void get_array_size(int32_t & dim1, int32_t & dim2)
        {
            dim1=dim1_size;
            dim2=dim2_size;
        }

        inline int32_t get_dim1() { return dim1_size; }

        inline int32_t get_dim2() { return dim2_size; }

        inline void zero() { CArray<T>::zero(); }

        inline void set_const(T const_elem)
        {
            CArray<T>::set_const(const_elem) ;
        }

        inline T* get_array() { return CArray<T>::array; }

        inline void set_array_name(const char * p_name)
        {
            CArray<T>::set_array_name(p_name);
        }

        inline void set_array(T* p_array, int32_t dim1, int32_t dim2, bool p_free_array=true, bool copy_array=false)
        {
            dim1_size=dim1;
            dim2_size=dim2;
            CArray<T>::set_array(p_array, dim1*dim2, p_free_array, copy_array);
        }

        inline bool resize_array(int32_t dim1, int32_t dim2)
        {
            dim1_size=dim1;
            dim2_size=dim2;
            return CArray<T>::resize_array(dim1*dim2);
        }

        inline const T& get_element(int32_t idx1, int32_t idx2) const
        {
            ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
            ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
            return CArray<T>::get_element(idx1+dim1_size*idx2);
        }

        inline bool set_element(const T& p_element, int32_t idx1, int32_t idx2)
        {
            ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
            ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
            return CArray<T>::set_element(p_element, idx1+dim1_size*idx2);
        }

        inline const T& element(int32_t idx1, int32_t idx2) const
        {
            return get_element(idx1,idx2);
        }

        inline T& element(int32_t idx1, int32_t idx2)
        {
            ARRAY_ASSERT((idx1>=0 && idx1<dim1_size));
            ARRAY_ASSERT((idx2>=0 && idx2<dim2_size));
            return CArray<T>::element(idx1+dim1_size*idx2);
        }

        inline T& element(T* p_array, int32_t idx1, int32_t idx2)
        {
            ARRAY_ASSERT(CArray<T>::array==p_array);
            ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
            ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
            return p_array[idx1+dim1_size*idx2];
        }

        inline T& element(T* p_array, int32_t idx1, int32_t idx2, int32_t p_dim1_size) 
        {
            ARRAY_ASSERT(CArray<T>::array==p_array);
            ARRAY_ASSERT(p_dim1_size==dim1_size);
            ARRAY_ASSERT(idx1>=0 && idx1<p_dim1_size);
            ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
            return p_array[idx1+p_dim1_size*idx2];
        }

        CArray2<T>& operator=(CArray2<T>& orig)
        {
            CArray<T>::operator=(orig);
            dim1_size=orig.dim1_size;
            dim2_size=orig.dim2_size;
            return *this;
        }

        void display_array() const
        {
            if (CArray<T>::get_name())
                CArray<T>::SG_PRINT( "2d-Array '%s' of size: %dx%d\n", CArray<T>::get_name(), dim1_size,dim2_size);
            else
                CArray<T>::SG_PRINT( "2d-Array of size: %dx%d\n",dim1_size,dim2_size);
            for (int32_t i=0; i<dim1_size; i++)
            {
                CArray<T>::SG_PRINT( "element(%d,:) = [ ",i);
                for (int32_t j=0; j<dim2_size; j++)
                    CArray<T>::SG_PRINT( "%1.1f,", (float32_t) element(i,j));
                CArray<T>::SG_PRINT( " ]\n");
            }
        }

        void display_size() const
        {
            CArray<T>::SG_PRINT( "2d-Array of size: %dx%d\n",dim1_size,dim2_size);
        }

        inline virtual const char* get_name() { return "Array2"; }

    protected:
        int32_t dim1_size;
        int32_t dim2_size;
};
}
#endif