/usr/src/RPM/BUILD/trilinos-11.12.1/packages/intrepid/src/Shared/MiniTensor/Intrepid_MiniTensor_Vector.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_Vector_h)
#define Intrepid_MiniTensor_Vector_h

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

#include "Intrepid_MiniTensor_TensorBase.h"

namespace Intrepid {

template<typename T, Index N>
struct vector_store
{
  typedef Storage<T, dimension_power<N, 1>::value> type;
};

template<typename T, Index N = DYNAMIC>
class Vector : public TensorBase<T, typename vector_store<T, N>::type>
{
public:

  static
  Index const
  ORDER = 1;

  static
  bool const
  IS_DYNAMIC = N == DYNAMIC;

  typedef typename vector_store<T, N>::type
  Store;

  static
  Index
  get_order() {return ORDER;}

  explicit
  Vector();

  explicit
  Vector(Index const dimension);

  explicit
  Vector(ComponentValue const value);

  explicit
  Vector(Index const dimension, ComponentValue const value);

  Vector(T const * data_ptr);

  Vector(Index const dimension, T const * data_ptr);

  Vector(Vector<T, N> const & v);

  Vector(T const & s0, T const & s1);

  Vector(T const & s0, T const & s1, T const & s2);

  ~Vector();

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

  T &
  operator()(Index const i);

  Index
  get_dimension() const;

  void
  set_dimension(Index const dimension);

};

template<typename S, typename T, Index N>
Vector<typename Promote<S, T>::type, N>
operator+(Vector<S, N> const & u, Vector<T, N> const & v);

template<typename S, typename T, Index N>
Vector<typename Promote<S, T>::type, N>
operator-(Vector<S, N> const & u, Vector<T, N> const & v);

template<typename T, Index N>
Vector<T, N>
operator-(Vector<T, N> const & u);

template<typename S, typename T, Index N>
typename Promote<S, T>::type
operator*(Vector<S, N> const & u, Vector<T, N> const & v);

template<typename T, Index N>
bool
operator==(Vector<T, N> const & u, Vector<T, N> const & v);

template<typename T, Index N>
bool
operator!=(Vector<T, N> const & u, Vector<T, N> const & v);

template<typename S, typename T, Index N>
typename lazy_disable_if< order_1234<S>, apply_vector< Promote<S,T>, N > >::type
operator*(S const & s, Vector<T, N> const & u);

template<typename S, typename T, Index N>
typename lazy_disable_if< order_1234<S>, apply_vector< Promote<S,T>, N > >::type
operator*(Vector<T, N> const & u, S const & s);

template<typename S, typename T, Index N>
Vector<typename Promote<S, T>::type, N>
operator/(Vector<T, N> const & u, S const & s);

template<typename S, typename T, Index N>
Vector<typename Promote<S, T>::type, N>
operator/(S const & s, Vector<T, N> const & u);

template<typename S, typename T, Index N>
typename Promote<S, T>::type
dot(Vector<S, N> const & u, Vector<T, N> const & v);

template<typename S, typename T, Index N>
Vector<typename Promote<S, T>::type, N>
cross(Vector<S, N> const & u, Vector<T, N> const & v);

template<typename T, Index N>
T
norm(Vector<T, N> const & u);

template<typename T, Index N>
T
norm_square(Vector<T, N> const & u);

template<typename T, Index N>
T
norm_1(Vector<T, N> const & u);

template<typename T, Index N>
T
norm_infinity(Vector<T, N> const & u);

template<typename T, Index N>
Vector<T, N>
unit(Vector<T, N> const & u);

template<typename T, Index N>
std::pair<Vector<T, N>, T>
house(Vector<T, N> const & x);

template<typename T, Index N>
std::istream &
operator>>(std::istream & is, Vector<T, N> & u);

template<typename T, Index N>
std::ostream &
operator<<(std::ostream & os, Vector<T, N> const & u);

} // namespace Intrepid

#include "Intrepid_MiniTensor_Vector.i.h"
#include "Intrepid_MiniTensor_Vector.t.h"

#endif //Intrepid_MiniTensor_Vector_h