// Template array classes with like-type math ops
/*

Copyright (C) 1996, 1997, 2003, 2004, 2005, 2006, 2007, 2008,
              2009 John W. Eaton

This file is part of Octave.

Octave 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.

Octave 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 Octave; see the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

*/

#if !defined (octave_MArrayN_h)
#define octave_MArrayN_h 1

#include "Array.h"
#include "MArray2.h"
#include "dim-vector.h"

// N-dimensional array with math ops.

// But first, some preprocessor abuse...

#include "MArray-decl.h"

MARRAY_OPS_FORWARD_DECLS (MArrayN, )

template <class T>
class
MArrayN : public Array<T>
{
protected:

  MArrayN (T *d, const dim_vector& dv) : Array<T> (d, dv) { }

public:
  
  MArrayN (void) : Array<T> () {}
  
  MArrayN (const dim_vector& dv) : Array<T> (dv) { }
  
  MArrayN (const dim_vector& dv, const T& val) : Array<T> (dv, val) { }

  template <class U>
  explicit MArrayN (const Array2<U>& a) : Array<T> (a) { }

  template <class U>
  MArrayN (const Array<U>& a) : Array<T> (a) { }

  template <class U>
  MArrayN (const MArrayN<U>& a) : Array<T> (a) { }

  ~MArrayN (void) { }

  MArrayN<T>& operator = (const MArrayN<T>& a)
    {
      Array<T>::operator = (a);
      return *this;
    }

  MArrayN<T> reshape (const dim_vector& new_dims) const
    { return Array<T>::reshape (new_dims); }

  MArrayN<T> permute (const Array<octave_idx_type>& vec, 
		      bool inv = false) const
    { return Array<T>::permute (vec, inv); }

  MArrayN<T> ipermute (const Array<octave_idx_type>& vec) const
    { return Array<T>::ipermute (vec); }

  MArrayN squeeze (void) const { return Array<T>::squeeze (); }

  MArrayN<T> diag (octave_idx_type k) const
  {
    return Array<T>::diag (k);
  }

  // Performs indexed accumulative addition.

  void idx_add (const idx_vector& idx, T val);

  void idx_add (const idx_vector& idx, const MArrayN<T>& vals);

  void idx_min (const idx_vector& idx, const MArrayN<T>& vals);

  void idx_max (const idx_vector& idx, const MArrayN<T>& vals);

  void changesign (void);
};

#endif