algebra/tensor_base.h

// -*- c++ -*-

// +--------------------------------------------------------------------+
// | This file is part of MathTL - the Mathematical Template Library    |
// |                                                                    |
// | Copyright (c) 2002-2009                                            |
// | Thorsten Raasch, Manuel Werner                                     |
// +--------------------------------------------------------------------+

#ifndef _MATHTL_TENSOR_BASE_H
#define _MATHTL_TENSOR_BASE_H

#include <iostream>
#include "algebra/tensor.h"
#include "utils/fixed_array1d.h"

namespace MathTL
{
  // general template declaration, see tensor.h
  template <unsigned int RANK, unsigned int DIM, class VALUE> class Tensor;
  template <unsigned int DIM, class VALUE> class Tensor<1, DIM, VALUE>;

  template <unsigned int DIM, class VALUE>
  class Tensor<1, DIM, VALUE>
  {
  public:
    typedef VALUE value_type;

    typedef size_t size_type;

    static const unsigned int dimension = DIM;

    static const unsigned int rank = 1;

    explicit Tensor(const bool initialize = true);

    void clear();

    const size_type size() const;
    
    const VALUE operator [] (const size_type i) const;

    VALUE& operator [] (const size_type i);

    bool operator == (const Tensor<1, DIM, VALUE>&) const;

    bool operator != (const Tensor<1, DIM, VALUE>&) const;

    Tensor<1, DIM, VALUE>& operator += (const Tensor<1, DIM, VALUE>&);

    void add(const VALUE s, const Tensor<1, DIM, VALUE>& T);

    Tensor<1, DIM, VALUE>& operator -= (const Tensor<1, DIM, VALUE>&);

    Tensor<1, DIM, VALUE>& operator *= (const VALUE s);

    Tensor<1, DIM, VALUE>& operator /= (const VALUE s);

    Tensor<1, DIM, VALUE> operator + (const Tensor<1, DIM, VALUE>&) const;

    Tensor<1, DIM, VALUE> operator - (const Tensor<1, DIM, VALUE>&) const;

    Tensor<1, DIM, VALUE> operator - () const;
    
    VALUE operator * (const Tensor<1, DIM, VALUE>&) const;

    static const size_type memory_consumption();
    
  protected:
    FixedArray1D<VALUE,DIM> values;
  };

  template <unsigned int DIM, class VALUE>
    std::ostream& operator << (std::ostream& os,
                               const Tensor<1, DIM, VALUE>& T);

  template <class VALUE>
  std::ostream& operator << (std::ostream& os,
                             const Tensor<1, 1, VALUE>& T);
}

#include <algebra/tensor_base.cpp>

#endif