traits.hpp

Go to the documentation of this file.

// traits.hpp
// 
// Copyright (c) 2009 - Michele De Stefano (micdestefano@users.sourceforge.net)
// 
// Distributed under the MIT License (See accompanying file COPYING)

#ifndef MDS_UTILS_UBLAS_TRAITS_HPP_INCLUDED
#define MDS_UTILS_UBLAS_TRAITS_HPP_INCLUDED

#include <boost/numeric/ublas/matrix.hpp>
#include <boost/numeric/ublas/matrix_sparse.hpp>
#include <boost/mpl/if.hpp>
#include <boost/mpl/and.hpp>
#include <boost/mpl/not.hpp>
#include <boost/mpl/has_xxx.hpp>

namespace mds_utils {
    
    namespace ublas {

/*
 * \brief   Defines the has_storage_category<T> boolean unary metafunction.
 * 
 * If \p T contains a nested typedef named \p storage_category then
 * inherits from std::true_type; otherwise it inherits from std::false_type.
 * 
 * \headerfile  traits.hpp  mds_utils/ublas/traits.hpp
 *
 * \author  Michele De Stefano
 * \date    25/05/2014
 */
BOOST_MPL_HAS_XXX_TRAIT_DEF(storage_category)

/*
 * \brief   Defines the has_index_array_type<T> boolean unary metafunction.
 * 
 * If \p T contains a nested typedef named \p has_index_array_type then
 * inherits from std::true_type; otherwise it inherits from std::false_type.
 * 
 * \headerfile  traits.hpp  mds_utils/ublas/traits.hpp
 *
 * \author  Michele De Stefano
 * \date    25/05/2014
 */
BOOST_MPL_HAS_XXX_TRAIT_DEF(index_array_type)

/*
 * \brief   Defines the has_value_array_type<T> boolean unary metafunction.
 * 
 * If \p T contains a nested typedef named \p index_array_type then
 * inherits from std::true_type; otherwise it inherits from std::false_type.
 * 
 * \headerfile  traits.hpp  mds_utils/ublas/traits.hpp
 *
 * \author  Michele De Stefano
 * \date    25/05/2014
 */
BOOST_MPL_HAS_XXX_TRAIT_DEF(value_array_type)


template<class T,class Enable = void>
struct is_vector : std::false_type {};

template<class T,class Enable = void>
struct is_matrix : std::false_type {};

template<class T,class Enable = void>
struct is_compressed_matrix : std::false_type {};


template<class T>
struct is_vector<T,
        typename std::enable_if<
            boost::mpl::and_<
                std::is_base_of<
                    boost::numeric::ublas::vector_container<T>,
                    T
                >,
                has_storage_category<T>,
                std::is_same<
                    typename T::storage_category,
                    boost::numeric::ublas::dense_tag
                >
            >::value
        >::type
    > : std::true_type {};


template<class T>
struct is_matrix<T,
        typename std::enable_if<
            boost::mpl::and_<
                std::is_base_of<
                    boost::numeric::ublas::matrix_container<T>,
                    T
                >,
                has_storage_category<T>,
                std::is_same<
                    typename T::storage_category,
                    boost::numeric::ublas::dense_tag
                >
            >::value
        >::type
    > : std::true_type {};



template<class T>
struct is_compressed_matrix<T,
        typename std::enable_if<
            boost::mpl::and_<
                std::is_base_of<
                    boost::numeric::ublas::matrix_container<T>,
                    T
                >,
                has_storage_category<T>,
                has_index_array_type<T>,
                has_value_array_type<T>,
                std::is_same<
                    typename T::storage_category,
                    boost::numeric::ublas::sparse_tag
                >
            >::value
        >::type
    > : std::true_type {};
    

template<class orientation_category>
struct opposite_orientation;

template<>
struct opposite_orientation<boost::numeric::ublas::row_major_tag> {
    typedef boost::numeric::ublas::column_major type;
};

template<>
struct opposite_orientation<boost::numeric::ublas::column_major_tag> {
    typedef boost::numeric::ublas::row_major    type;
};


    }
}

#endif