Array.h

Go to the documentation of this file.

//Copyright (c) 2004-2005, Baris Sumengen
//All rights reserved.
//
// CIMPL Matrix Performance Library
//
//Redistribution and use in source and binary
//forms, with or without modification, are
//permitted provided that the following
//conditions are met:
//
//    * No commercial use is allowed. 
//    This software can only be used
//    for non-commercial purposes. This 
//    distribution is mainly intended for
//    academic research and teaching.
//    * Redistributions of source code must
//    retain the above copyright notice, this
//    list of conditions and the following
//    disclaimer.
//    * Redistributions of binary form must
//    mention the above copyright notice, this
//    list of conditions and the following
//    disclaimer in a clearly visible part 
//    in associated product manual, 
//    readme, and web site of the redistributed 
//    software.
//    * 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.
//    * The name of Baris Sumengen may not 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
//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.



#pragma once
#ifndef ARRAY_H
#define ARRAY_H

#include "./cimpl.h"


#include <cstdarg>

#include <iostream>

using std::cout;
using std::cerr;
using std::endl;



namespace CIMPL
{

// forward declaration
template< class T > class Array;
template< class T > class Matrix;
template< class T > class Vector;

template< class T >
class Array
{

        friend class Matrix<T>;
        friend class Vector<T>;


protected:
        T *data;
        int ndims;
        int length;
        int *dims;
        Cleaner<T> *clean;   // Reference counting Garbage collector.


public:
        Array();
        explicit Array(const int);
        Array(const int, const int);
        Array(const int, const int, const int);
        Array(const int, const int, const int, const int, ...);
        Array(const int _ndims, const int* _dims);
        Array(Array<T> &m);


        ~Array();

        // Useful for passing data to third party libraries.
        const T* DataPtr();
        T* Data();

        Array<T> Clone() const;



        const int XDim() const;
        const int YDim() const;
        const int ZDim() const;
        const int* Dims() const;
        const int* Size() const;
        int Length() const;
        int NDims() const;
        void Init(const T init);



        static bool IsCompatible(Array<T>& m1, Array<T>& m2);

        // Boolean Operations...
        static Array<int> And(Array<T>& m1, Array<T>& m2);
        static Array<int> Or(Array<T>& m1, Array<T>& m2);
        static Array<int> Lt(Array<T>& m1, Array<T>& m2);
        static Array<int> Gt(Array<T>& m1, Array<T>& m2);
        static Array<int> Le(Array<T>& m1, Array<T>& m2);
        static Array<int> Ge(Array<T>& m1, Array<T>& m2);
        static Array<int> Eq(Array<T>& m1, Array<T>& m2);
        static Array<int> Ne(Array<T>& m1, Array<T>& m2);

        // Boolean Operations with value type...
        static Array<int> And(Array<T>& m, T v);
        static Array<int> Or(Array<T>& m, T v);
        static Array<int> Lt(Array<T>& m, T v);
        static Array<int> Gt(Array<T>& m, T v);
        static Array<int> Le(Array<T>& m, T v);
        static Array<int> Ge(Array<T>& m, T v);
        static Array<int> Eq(Array<T>& m, T v);
        static Array<int> Ne(Array<T>& m, T v);


        // Add matrix to another matrix
        static Array<T> Add(Array<T>& m1, Array<T>& m2);
        static Array<T> Subtract(Array<T>& m1, Array<T>& m2);
        static Array<T> Multiply(Array<T>& m1, Array<T>& m2);
        static Array<T> Divide(Array<T>& m1, Array<T>& m2);

        // Add value to another matrix
        static Array<T> Add(Array<T>& m1, T v2);
        static Array<T> Subtract(Array<T>& m1, T v2);
        static Array<T> Subtract(T v2, Array<T>& m1);
        static Array<T> Multiply(Array<T>& m1, T v2);
        static Array<T> Divide(Array<T>& m1, T v2);
        static Array<T> Divide(T v2, Array<T>& m1);



        // Add matrix to "this" matrix
        Array<T>& Add(Array<T>& m);
        Array<T>& Subtract(Array<T>& m);
        Array<T>& Multiply(Array<T>& m);
        Array<T>& Divide(Array<T>& m);

        // Add value to "this" matrix
        Array<T>& Add(T v);
        Array<T>& Subtract(T v);
        Array<T>& Multiply(T v);
        Array<T>& Divide(T v);





// OPERATORS

        // Assignment
        Array<T>& operator= (Array<T>& m);
        Array<T>& operator= (Matrix<T>& m);
        //***
        Array<T>& operator= (Vector<T>& m);


        // Unary +-!
        Array<T> operator+ ();
        Array<T> operator- ();
        Array<int> operator! ();


        // Access to the elements
        T& operator() (const int i);
        
                // no bounds cheking...
        T& operator[] (const int i);
        
        
        T& operator() (const int i, const int j, ...);


        T& Elem(const int i, const int j, ...);
        T& ElemNC(const int i, const int j, ...); // No bounds check
        T& Elem(const int i);
        T& ElemNC(const int i); // No bounds check



        // Boolean operations
        friend Array<int> operator&& (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::And(m1, m2);
        }

        friend Array<int> operator|| (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Or(m1, m2);
        }

        friend Array<int> operator< (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Lt(m1, m2);
        }

        friend Array<int> operator> (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Gt(m1, m2);
        }

        friend Array<int> operator<= (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Le(m1, m2);
        }

        friend Array<int> operator>= (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Ge(m1, m2);
        }

        friend Array<int> operator== (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Eq(m1, m2);
        }

        friend Array<int> operator!= (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Ne(m1, m2);
        }



        // Boolean operations with value type
        friend Array<int> operator&& (Array<T>& m, T v)
        {
                return Array<T>::And(m, v);
        }
        friend Array<int> operator&& (T v, Array<T>& m)
        {
                return Array<T>::And(m, v);
        }

        friend Array<int> operator|| (Array<T>& m, T v)
        {
                return Array<T>::Or(m, v);
        }
        friend Array<int> operator|| (T v, Array<T>& m)
        {
                return Array<T>::Or(m, v);
        }

        friend Array<int> operator< (Array<T>& m, T v)
        {
                return Array<T>::Lt(m, v);
        }
        friend Array<int> operator< (T v, Array<T>& m)
        {
                return Array<T>::Gt(m, v);
        }

        friend Array<int> operator> (Array<T>& m, T v)
        {
                return Array<T>::Gt(m, v);
        }
        friend Array<int> operator> (T v, Array<T>& m)
        {
                return Array<T>::Lt(m, v);
        }

        friend Array<int> operator<= (Array<T>& m, T v)
        {
                return Array<T>::Le(m, v);
        }
        friend Array<int> operator<= (T v, Array<T>& m)
        {
                return Array<T>::Ge(m, v);
        }

        friend Array<int> operator>= (Array<T>& m, T v)
        {
                return Array<T>::Ge(m, v);
        }
        friend Array<int> operator>= (T v, Array<T>& m)
        {
                return Array<T>::Le(m, v);
        }

        friend Array<int> operator== (Array<T>& m, T v)
        {
                return Array<T>::Eq(m, v);
        }
        friend Array<int> operator== (T v, Array<T>& m)
        {
                return Array<T>::Eq(m, v);
        }

        friend Array<int> operator!= (Array<T>& m, T v)
        {
                return Array<T>::Ne(m, v);
        }
        friend Array<int> operator!= (T v, Array<T>& m)
        {
                return Array<T>::Ne(m, v);
        }





        // Matrix to Matrix elementwise math operations.
        friend Array<T> operator+ (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Add(m1, m2);
        }

        friend Array<T> operator- (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Subtract(m1, m2);
        }

        friend Array<T> operator* (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Multiply(m1, m2);
        }

        friend Array<T> operator/ (Array<T>& m1, Array<T>& m2)
        {
                return Array<T>::Divide(m1, m2);
        }



        // Matrix - value math operations.
        friend Array<T> operator+ (Array<T>& m, T v)
        {
                return Array<T>::Add(m, v);
        }

        friend Array<T> operator+ (T v, Array<T>& m)
        {
                return Array<T>::Add(m, v);
        }

        friend Array<T> operator- (Array<T>& m, T v)
        {
                return Array<T>::Subtract(m, v);
        }

        friend Array<T> operator- (T v, Array<T>& m)
        {
                return Array<T>::Subtract(v, m);
        }

        friend Array<T> operator* (Array<T>& m, T v)
        {
                return Array<T>::Multiply(m, v);
        }

        friend Array<T> operator* (T v, Array<T>& m)
        {
                return Array<T>::Multiply(m, v);
        }

        friend Array<T> operator/ (Array<T>& m, T v)
        {
                return Array<T>::Divide(m, v);
        }

        friend Array<T> operator/ (T v, Array<T>& m)
        {
                return Array<T>::Divide(v, m);
        }




        // Inline math operations
        Array<T>& operator+= (Array<T>& m);
        Array<T>& operator-= (Array<T>& m);
        Array<T>& operator*= (Array<T>& m);
        Array<T>& operator/= (Array<T>& m);

        Array<T>& operator+= (T v);
        Array<T>& operator-= (T v);
        Array<T>& operator*= (T v);
        Array<T>& operator/= (T v);


// TYPE CONVERSIONS
        Array(Matrix<T> &m);
        Array(Vector<T> &m);


};


}; //namespace



#include "./Array.inl"





#endif

---