SGNDArray.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) 2012 Fernando José Iglesias García
 * Written (W) 2010,2012 Soeren Sonnenburg
 * Copyright (C) 2010 Berlin Institute of Technology
 * Copyright (C) 2012 Soeren Sonnenburg
 */

#ifndef __SGNDARRAY_H__
#define __SGNDARRAY_H__

#include <shogun/lib/config.h>

#include <shogun/lib/SGReferencedData.h>
#include <shogun/lib/SGVector.h>
#include <shogun/io/SGIO.h>

namespace shogun
{
template<class T> class SGNDArray : public SGReferencedData
{
    public:
        SGNDArray();

        SGNDArray(T* a, index_t* d, index_t nd, bool ref_counting=true);

        SGNDArray(index_t* d, index_t nd, bool ref_counting=true);

        SGNDArray(SGVector<index_t> d, bool ref_counting=true);

        SGNDArray(const SGNDArray &orig);

        virtual ~SGNDArray();

        SGNDArray<T> clone() const;

        T* get_matrix(index_t matIdx) const
        {
            ASSERT(array && dims && num_dims > 2 && dims[2] > matIdx)
            return &array[int64_t(matIdx)*int64_t(dims[0])*dims[1]];
        }

        void transpose_matrix(index_t matIdx) const;

        inline const T& operator[](index_t index) const
        {
            return array[index];
        }

        inline T& operator[](index_t index)
        {
            return array[index];
        }

        SGVector<index_t> get_dimensions() const;

        void set_const(T const_elem);

        SGNDArray<T>& operator*=(T val);

        SGNDArray<T>& operator+=(SGNDArray& ndarray);

        SGNDArray<T>& operator-=(SGNDArray& ndarray);

        T max_element(index_t& max_at);

        void expand(SGNDArray& big_array, SGVector<index_t>& axes);

        T get_value(SGVector<index_t> index) const;

        void next_index(SGVector<index_t>& curr_index) const;

    protected:

        virtual void copy_data(const SGReferencedData &orig);

        virtual void init_data();

        virtual void free_data();

    public:

        T* array;

        index_t* dims;

        index_t num_dims;

        index_t len_array;
};
}
#endif // __SGNDARRAY_H__