tjarray.h

 /***************************************************************************
                          tjvector.h  -  description
                             -------------------
    begin                : Thu Feb 22 2001
    copyright            : (C) 2001 by Thies Jochimsen
    email                : jochimse@cns.mpg.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/


#ifndef TJARRAY_H
#define TJARRAY_H



#include <tjutils/tjvector.h>
#include <tjutils/tjlog.h>


class ndim : public STD_vector<unsigned long> {

public:

  ndim (unsigned long d=0);

  ndim (const ndim& mm) : STD_vector<unsigned long>(mm) {}

  ndim (const STD_string& s);

  unsigned long dim() const {return size();}

  operator STD_string () const;

  friend STD_ostream& operator << (STD_ostream& s,const ndim& nn) { return s << STD_string(nn);}

  ndim& operator -- ( );

  ndim& operator -- (int);

  ndim& add_dim ( unsigned long e, bool first=false );

  unsigned long total() const;

  unsigned long extent2index(const ndim& mm) const;

  ndim index2extent(unsigned long index) const;

  bool operator == (const ndim& nn) const;

  bool operator != (const ndim& nn) const;

  ndim& reduce ( unsigned long dim );

  ndim& autosize ();
};





template<class V, class T> class tjarray : public V {

public:


  tjarray ();


  tjarray (unsigned long n1);
  tjarray (unsigned long n1, unsigned long n2);
  tjarray (unsigned long n1, unsigned long n2, unsigned long n3);
  tjarray (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4);
  tjarray (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4, unsigned long n5);


  tjarray (const tjarray<V,T> &ta);


  tjarray (const V& sv);


  tjarray (const ndim &nn);


  tjarray<V,T>& operator = (const tjarray<V,T>& ta);

  tjarray<V,T>& operator = (const T& value);


  V& resize(unsigned int newsize);


  tjarray<V,T>& redim (const ndim &nn);


  tjarray<V,T>& redim (unsigned long n1);
  tjarray<V,T>& redim (unsigned long n1, unsigned long n2);
  tjarray<V,T>& redim (unsigned long n1, unsigned long n2, unsigned long n3);
  tjarray<V,T>& redim (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4);
  tjarray<V,T>& redim (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4, unsigned long n5);


  tjarray<V,T>& autosize () {extent.autosize(); return *this;}


  const ndim& get_extent () const;


  T& operator () (const ndim& ii);


  const T& operator () (const ndim& ii) const;


  T& operator () (unsigned long n1);
  T& operator () (unsigned long n1, unsigned long n2);
  T& operator () (unsigned long n1, unsigned long n2, unsigned long n3);
  T& operator () (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4);
  T& operator () (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4, unsigned long n5);


  const T& operator () (unsigned long n1) const;
  const T& operator () (unsigned long n1, unsigned long n2) const;
  const T& operator () (unsigned long n1, unsigned long n2, unsigned long n3) const;
  const T& operator () (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4) const;
  const T& operator () (unsigned long n1, unsigned long n2, unsigned long n3, unsigned long n4, unsigned long n5) const;


  unsigned long dim() const;


  unsigned long size(unsigned long i) const;


  unsigned long total() const;


  unsigned long length() const;

  unsigned int elementsize() const;

  tjarray<V,T>& assignValues(const tjarray<V,T> &ta) ;


  tjarray<V,T>& copy(const tjarray<V,T> &ta) ;


  STD_string printbody() const;


  ndim create_index(unsigned long index) const;


 protected:

  STD_ostream& printbody2stream(STD_ostream& s) const; // required for JDX arrays


 private:

  static ndim create_extent(unsigned long n1);
  static ndim create_extent(unsigned long n1,unsigned long n2);
  static ndim create_extent(unsigned long n1,unsigned long n2,unsigned long n3);
  static ndim create_extent(unsigned long n1,unsigned long n2,unsigned long n3,unsigned long n4);
  static ndim create_extent(unsigned long n1,unsigned long n2,unsigned long n3,unsigned long n4,unsigned long n5);

  ndim extent;

  T element_dummy;
};


//    Aliases:

typedef tjarray<fvector,float>       farray;

typedef tjarray<dvector,double>     darray;

typedef tjarray<ivector,int>        iarray;


typedef tjarray<cvector,STD_complex> carray;


typedef tjarray<svector,STD_string>   sarray;



// Helper functions:

  STD_string print_table(const sarray& table);


  sarray parse_table(const STD_string& str);


#endif