ProxyReferenceTraits.h

Go to the documentation of this file.

/*!
 * 
 *
 * \brief       Traits which allow to define ProxyReferences for types
 * 
 * A ProxyReference can be used in the context of abstract functions to bind several related types
 * of arguments to a single proxy type. Main use are ublas expression templates so that
 * vectors, matrix rows and subvectors can be treated as one argument type
 * 
 * 
 *
 * \author      O.Krause
 * \date        2012
 *
 *
 * \par Copyright 1995-2017 Shark Development Team
 * 
 * <BR><HR>
 * This file is part of Shark.
 * <https://shark-ml.github.io/Shark/>
 * 
 * Shark 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 3 of the License, or
 * (at your option) any later version.
 * 
 * Shark 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 Shark.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef SHARC_CORE_PROXYREFERENCETRAITS_H
#define SHARC_CORE_PROXYREFERENCETRAITS_H
#include <string>
#include <shark/LinAlg/Base.h>
namespace shark {
    ///\brief sets the type of ProxxyReference
    ///
    ///A Proxy referencecan be used when several related types are to be treated by one proxy type
    ///argument, for example expression templates
    template<class T>
    struct ConstProxyReference{
        typedef T const& type;
    };
    
    /// \cond
    
    template<class T>
    struct ConstProxyReference<blas::vector<T> >{
        typedef blas::dense_vector_adaptor<T const> const& type;
    };
    template<class T>
    struct ConstProxyReference<blas::vector<T> const>{
        typedef blas::dense_vector_adaptor<T const> const& type;
    };
    template<class T>
    struct ConstProxyReference<blas::compressed_vector<T> >{
        typedef blas::compressed_vector_adaptor<T const,std::size_t const> const& type;
    };
    template<class T>
    struct ConstProxyReference<blas::compressed_vector<T> const >{
        typedef blas::compressed_vector_adaptor<T const,std::size_t const> const& type;
    };
    template<class T>
    struct ConstProxyReference<blas::matrix<T> >{
        typedef blas::dense_matrix_adaptor<T const,blas::row_major> const& type;
    };
    template<class T>
    struct ConstProxyReference<blas::matrix<T> const >{
        typedef blas::dense_matrix_adaptor<T const,blas::row_major> const& type;
    };
    
    /// \endcond
}
#endif