Vector2.hxx

// Copyright (C) 2010, INRIA
// Author(s): Marc Fragu, Vivien Mallet
// Copyright (C) 2011, Vivien Mallet
//
// This file is part of the linear-algebra library Seldon,
// http://seldon.sourceforge.net/.
//
// Seldon is free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 2.1 of the License, or (at your option)
// any later version.
//
// Seldon 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 Lesser General Public License for
// more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Seldon. If not, see http://www.gnu.org/licenses/.
 
 
#ifndef SELDON_FILE_VECTOR_VECTOR2_HXX
 
 
#ifndef SELDON_VECTOR2_DEFAULT_ALLOCATOR_1
 
#define SELDON_VECTOR2_DEFAULT_ALLOCATOR_1 MallocObject
#endif
 
 
namespace Seldon
{
 
 
 
  template <class T, class Allocator0 =
            typename SeldonDefaultAllocator<VectFull, T>::allocator,
            class Allocator1 = SELDON_VECTOR2_DEFAULT_ALLOCATOR_1<
              Vector<T, VectFull, Allocator0> > >
  class Vector2
  {
  public:
    typedef T value_type;
    typedef T* pointer;
    typedef const T* const_pointer;
    typedef T& reference;
    typedef const T& const_reference;
 
  protected:
    Vector<Vector<T, VectFull, Allocator0>, VectFull, Allocator1> data_;
 
  public:
 
    /*** Constructors and destructor ***/
 
    Vector2();
    Vector2(long length);
    Vector2(const Vector<long>& length);
    ~Vector2();
 
    /*** Management of the vectors ***/
 
    bool IsEmpty() const;
    long GetLength() const;
    long GetSize() const;
    long GetLength(long i) const;
    long GetSize(long i) const;
    size_t GetMemorySize() const;
    long GetNelement() const;
    long GetNelement(long beg, long end) const;
    Vector<long> GetShape() const;
    void GetShape(Vector<long>& shape) const;
    void Reallocate(long M);
    void Reallocate(long i, long N);
    void Reallocate(const Vector<long>& length);
    void Select(long beg, long end);
    Vector<T, VectFull, Allocator0> Flatten() const;
    template <class Td, class Allocatord>
    void Flatten(Vector<Td, VectFull, Allocatord>& data) const;
    template <class Td, class Allocatord>
    void Flatten(long beg, long end, Vector<Td, VectFull, Allocatord>& data)
      const;
 
    void PushBack(long i, const T& x);
    void PushBack(const Vector<T, VectFull, Allocator0>& X);
#ifndef SWIG
    void PushBack(const Vector<Vector<T, VectFull, Allocator0>,
                  VectFull, Allocator1>& V);
#endif
    void PushBack(const Vector2<T, Allocator0, Allocator1>& V);
 
    void Clear();
    void Clear(long i);
 
    void Fill(const T& x);
 
    Vector<Vector<T, VectFull, Allocator0>, VectFull, Allocator1>&
    GetVector();
#ifndef SWIG
    const Vector<Vector<T, VectFull, Allocator0>, VectFull,
                 Allocator1> GetVector() const;
#endif
 
    Vector<T, VectFull, Allocator0>& GetVector(long i);
#ifndef SWIG
    const Vector<T, VectFull, Allocator0>& GetVector(long i) const;
#endif
 
    void Copy(const Vector2<T, Allocator0, Allocator1>& V);
    Vector2<T, Allocator0, Allocator1> Copy() const;
 
    /*** Element access and assignment ***/
 
#ifndef SWIG
    const Vector<T, VectFull, Allocator0>& operator() (long i) const;
#endif
    Vector<T, VectFull, Allocator0>& operator() (long i);
#ifndef SWIG
    const_reference operator() (long i, long j) const;
#endif
    reference operator() (long i, long j);
 
    /*** Convenient methods ***/
 
    template <class V2>
    bool HasSameShape(const V2& V) const;
    void Print() const;
 
    /*** Input/output functions ***/
 
    void Write(string file_name, bool with_size = true) const;
    void Write(ostream& file_stream, bool with_size = true) const;
    void Read(string file_name, bool with_size = true);
    void Read(istream& file_stream, bool with_size = true);
  };
 
 
}
 
 
#define SELDON_FILE_VECTOR_VECTOR2_HXX
#endif