/usr/src/RPM/BUILD/trilinos-11.12.1/packages/intrepid/src/Shared/MiniTensor/Intrepid_MiniTensor_TensorBase.h

// @HEADER
// ************************************************************************
//
//                           Intrepid Package
//                 Copyright (2007) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR 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.
//
// Questions: Alejandro Mota (amota@sandia.gov)
//
// ************************************************************************
// @HEADER

#if !defined(Intrepid_MiniTensor_TensorBase_h)
#define Intrepid_MiniTensor_TensorBase_h

#include <algorithm>
#include <cassert>
#include <iostream>
#include <vector>

#include "Intrepid_MiniTensor_Storage.h"
#include "Intrepid_MiniTensor_Utilities.h"

namespace Intrepid {

enum ComponentValue {
  ZEROS,
  ONES,
  SEQUENCE,
  RANDOM_UNIFORM,
  RANDOM_NORMAL,
  NANS};

template<typename T, typename ST>
class TensorBase
{
public:

  typedef T value_type;

  typedef ST storage_type;

  TensorBase();

  explicit
  TensorBase(Index const dimension, Index const order);

  TensorBase(Index const dimension, Index const order,
      ComponentValue const value);

  TensorBase(Index const dimension, Index const order, T const & s);

  TensorBase(Index const dimension, Index const order, T const * data_ptr);

  TensorBase(TensorBase<T, ST> const & X);

  TensorBase<T, ST> &
  operator=(TensorBase<T, ST> const & X);

  virtual
  ~TensorBase() = 0;

  T const &
  operator[](Index const i) const;

  T &
  operator[](Index const i);

  Index
  get_number_components() const;

  void
  fill(ComponentValue const value);

  void
  fill(T const & s);

  void
  fill(T const * data_ptr);

  template<typename S, typename SS>
  TensorBase<T, ST> &
  operator+=(TensorBase<S, SS> const & X);

  template<typename S, typename SS>
  TensorBase<T, ST> &
  operator-=(TensorBase<S, SS> const & X);

  template<typename S>
  TensorBase<T, ST> &
  operator*=(S const & X);

  template<typename S>
  TensorBase<T, ST> &
  operator/=(S const & X);

  void
  clear();

protected:

  void
  set_number_components(Index const number_components);

  Index
  get_dimension() const;

  void
  set_dimension(Index const dimension, Index const order);

  ST
  components_;

  Index
  dimension_;

};

template<typename T, typename ST>
T
norm_f(TensorBase<T, ST> const & X);

template<typename T, typename ST>
T
norm_f_square(TensorBase<T, ST> const & X);

template<typename R, typename S, typename T, typename SR, typename SS,
typename ST>
void
add(
    TensorBase<R, SR> const & A,
    TensorBase<S, SS> const & B,
    TensorBase<T, ST> & C);

template<typename R, typename S, typename T, typename SR, typename SS,
typename ST>
void
subtract(
    TensorBase<R, SR> const & A,
    TensorBase<S, SS> const & B,
    TensorBase<T, ST> & C);

template<typename T, typename ST>
void
minus(TensorBase<T, ST> const & A, TensorBase<T, ST> & B);

template<typename T, typename ST>
bool
equal(TensorBase<T, ST> const & A, TensorBase<T, ST> const & B);

template<typename T, typename ST>
bool
not_equal(TensorBase<T, ST> const & A, TensorBase<T, ST> const & B);

template<typename R, typename S, typename T, typename SR, typename ST>
void
scale(TensorBase<R, SR> const & A, S const & s, TensorBase<T, ST> & B);

template<typename R, typename S, typename T, typename SR, typename ST>
void
divide(TensorBase<R, SR> const & A, S const & s, TensorBase<T, ST> & B);

template<typename R, typename S, typename T, typename SR, typename ST>
void
split(TensorBase<R, SR> const & A, S const & s, TensorBase<T, ST> & B);

} // namespace Intrepid

#include "Intrepid_MiniTensor_TensorBase.i.h"
#include "Intrepid_MiniTensor_TensorBase.t.h"

#endif //Intrepid_MiniTensor_TensorBase_h