vector_utils_decl.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// Antioch - A Gas Dynamics Thermochemistry Library
//
// Copyright (C) 2014-2016 Paul T. Bauman, Benjamin S. Kirk,
//                         Sylvain Plessis, Roy H. Stonger
//
// Copyright (C) 2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef ANTIOCH_VECTOR_UTILS_DECL_H
#define ANTIOCH_VECTOR_UTILS_DECL_H

#ifdef ANTIOCH_METAPROGRAMMING_H
#  error vector_utils_decl.h must be included before metaprogramming.h
#endif

// Antioch
#include "antioch/metaprogramming_decl.h"

// C++
#include <iostream>
#include <vector>

// Add some overloads

namespace std
{

template <typename T>
inline
std::ostream&
operator<< (std::ostream& output, const std::vector<T>& a);

template <typename T>
inline
std::vector<T>
operator* (const std::vector<T>& src, const T & mul);

template <typename T>
inline
std::vector<T>
operator/ (const std::vector<T>& src, const T & mul);

} // end namespace std

namespace Antioch
{

// Class to allow tag dispatching to std::vector specializations
struct vector_library_tag : public numeric_library_tag {};

template <typename T, typename NewScalar>
struct rebind<std::vector<T>, NewScalar>;

template <typename T>
struct has_size<std::vector<T> >;

template <typename T>
struct return_auto<std::vector<T> >;

template <typename T>
struct size_type<std::vector<T> >;

template <typename T>
struct value_type<std::vector<T> >;

template <typename T>
struct raw_value_type<std::vector<T> >;

template <typename T>
inline
std::vector<T>
zero_clone(const std::vector<T>& example);

template <typename T1, typename T2>
inline
void
zero_clone(std::vector<T1>& output, const std::vector<T2>& example);

template <typename T, typename Scalar>
inline
std::vector<T>
constant_clone(const std::vector<T>& example, const Scalar& value);

// A function for zero-setting vectorized numeric types
template <typename T>
inline
void set_zero(std::vector<T>& a);

template <typename T, typename VectorScalar>
inline
std::vector<T> custom_clone(const std::vector<T> & vec, const VectorScalar & vecsrc, const std::vector<unsigned int> & indexes);

} // end namespace Antioch


#endif //ANTIOCH_VECTOR_UTILS_DECL_H