BatchInterface.h

Go to the documentation of this file.

/*!
 * 
 *
 * \brief       Defines the Batch Interface for a type, e.g., for every type a container with optimal structure.
 * 
 * 
 *
 * \author      O.Krause
 * \date        2012
 *
 *
 * \par Copyright 1995-2017 Shark Development Team
 * 
 * <BR><HR>
 * This file is part of Shark.
 * <http://shark-ml.org/>
 * 
 * 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 SHARK_DATA_BATCHINTERFACE_H
#define SHARK_DATA_BATCHINTERFACE_H

#include <shark/LinAlg/Base.h>
#include <shark/Core/utility/Iterators.h>

#include <boost/utility/enable_if.hpp>
#include <boost/mpl/if.hpp>
#include <type_traits>

namespace shark{

namespace detail{

/// \brief default implementation of a batch where BatchType is a proper sequence
template<class BatchType>
struct SimpleBatch{
    /// \brief Type of a batch of elements.
    typedef BatchType type;
    /// \brief Type of a single element.
    typedef typename type::reference reference;
    /// \brief Type of a single immutable element.
    typedef typename type::const_reference const_reference;
    
    
    /// \brief The type of the elements stored in the batch 
    typedef typename type::value_type value_type;
    
    /// \brief the iterator type of the object
    typedef typename type::iterator iterator;
    /// \brief the const_iterator type of the object
    typedef typename type::const_iterator const_iterator;
    
    
    ///\brief creates a batch able to store elements of the structure of input (e.g. same dimensionality)
    static type createBatch(value_type const& input, std::size_t size = 1){
        return type(size,input);
    }
    
    ///\brief creates a batch storing the elements referenced by the provided range
    template<class Iterator>
    static type createBatchFromRange(Iterator const& begin, Iterator const& end){
        type batch = createBatch(*begin,end-begin);
        typename type::reference c=batch[0];
        c=*begin;
        std::copy(begin,end,batch.begin());
        return batch;
    }
    
    template<class T>
    static void resize(T& batch, std::size_t batchSize, std::size_t elements){
        batch.resize(batchSize);
    }
    
    //~ ///\brief Swaps the ith element in the first batch with the jth element in the second batch
    //~ template<class T, class U>
    //~ static void swap(T& batchi, U& batchj, std::size_t i, std::size_t j){
        //~ using std::swap;
        //~ swap(batchi[i],batchj[j]);
    //~ }
    
    template<class T>
    static std::size_t size(T const& batch){return batch.size();}
    
    template<class T>
    static typename T::reference get(T& batch, std::size_t i){
        return batch[i];
    }
    template<class T>
    static typename T::const_reference get(T const& batch, std::size_t i){
        return batch[i];
    }
    template<class T>
    static typename T::iterator begin(T& batch){
        return batch.begin();
    }
    template<class T>
    static typename T::const_iterator begin(T const& batch){
        return batch.begin();
    }
    template<class T>
    static typename T::iterator end(T& batch){
        return batch.end();
    }
    template<class T>
    static typename T::const_iterator end(T const& batch){
        return batch.end();
    }
};



///\brief Wrapper for a matrix row, which offers a conversion operator to
/// to the Vector Type.
template<class Matrix>
class MatrixRowReference: public blas::temporary_proxy<blas::matrix_row<Matrix> >{
private:
    typedef blas::temporary_proxy<blas::matrix_row<Matrix> > base_type;
public:
    typedef typename blas::vector_temporary<Matrix>::type Vector;

    MatrixRowReference( Matrix& matrix, std::size_t i)
    :base_type(blas::matrix_row<Matrix>(matrix,i)){}
    template<class T>//special version allows for const-conversion
    MatrixRowReference(T const& matrixrow)
    :base_type(blas::matrix_row<Matrix>(matrixrow.expression(),matrixrow.index())){}
    
    template<class T> 
    const MatrixRowReference& operator=(const T& argument){
        static_cast<base_type&>(*this)=argument;
        return *this;
    }
    
    operator Vector(){
        return Vector(*this);
    }
};

template<class M>
void swap(MatrixRowReference<M> ref1, MatrixRowReference<M> ref2){
    swap_rows(ref1.expression().expression(),ref1.index(),ref2.expression().expression(),ref2.index());
}

template<class M1, class M2>
void swap(MatrixRowReference<M1> ref1, MatrixRowReference<M2> ref2){
    swap_rows(ref1.expression().expression(),ref1.index(),ref2.expression().expression(),ref2.index());
}

template<class Matrix>
struct VectorBatch{
    /// \brief Type of a batch of elements.
    typedef typename blas::matrix_temporary<Matrix>::type type;
    
    /// \brief The type of the elements stored in the batch 
    typedef typename blas::vector_temporary<Matrix>::type value_type;
    
    
    /// \brief Type of a single element.
    typedef detail::MatrixRowReference<Matrix> reference;
    /// \brief Type of a single immutable element.
    typedef detail::MatrixRowReference<const Matrix> const_reference;
    
    
    /// \brief the iterator type of the object
    typedef ProxyIterator<Matrix, value_type, reference > iterator;
    /// \brief the const_iterator type of the object
    typedef ProxyIterator<const Matrix, value_type, const_reference > const_iterator;
    
    ///\brief creates a batch with input as size blueprint
    template<class Element>
    static type createBatch(Element const& input, std::size_t size = 1){
        return type(size,input.size());
    }
    ///\brief creates a batch storing the elements referenced by the provided range
    template<class Iterator>
    static type createBatchFromRange(Iterator const& pos, Iterator const& end){
        type batch(end - pos,pos->size());
        std::copy(pos,end,begin(batch));
        return batch;
    }
    
    
    static void resize(Matrix& batch, std::size_t batchSize, std::size_t elements){
        ensure_size(batch,batchSize,elements);
    }
    
    static std::size_t size(Matrix const& batch){return batch.size1();}
    static reference get( Matrix& batch, std::size_t i){
        return reference(batch,i);
    }
    static const_reference get( Matrix const& batch, std::size_t i){
        return const_reference(batch,i);
    }
    
    static iterator begin(Matrix& batch){
        return iterator(batch,0);
    }
    static const_iterator begin(Matrix const& batch){
        return const_iterator(batch,0);
    }
    
    static iterator end(Matrix& batch){
        return iterator(batch,batch.size1());
    }
    static const_iterator end(Matrix const& batch){
        return const_iterator(batch,batch.size1());
    }
};


}

///\brief class which helps using different batch types
///
/// e.g. creating a batch of a single element or returning a single element
/// when the element type is arithmetic, like int,double, std::complex,...
/// the return value will be a linear algebra compatible vector, like RealVector.
/// If it is not, for example a string, the return value will be a std::vector<T>. 
template<class T>
//see detail above for implementations, we just choose the correct implementations based on
//whether T is arithmetic or not
struct Batch
:public std::conditional<
    std::is_arithmetic<T>::value,
    detail::SimpleBatch<blas::vector<T> >,
    detail::SimpleBatch<std::vector<T> >
>::type{};

/// \brief specialization for vectors which should be matrices in batch mode!
template<class T>
struct Batch<blas::vector<T> >: public detail::VectorBatch<blas::matrix<T> >{};

/// \brief specialization for ublas compressed vectors which are compressed matrices in batch mode!
template<class T>
struct Batch<shark::blas::compressed_vector<T> >{
    /// \brief Type of a batch of elements.
    typedef shark::blas::compressed_matrix<T> type;
    
    /// \brief The type of the elements stored in the batch 
    typedef shark::blas::compressed_vector<T> value_type;
    
    
    /// \brief Type of a single element.
    typedef detail::MatrixRowReference<type> reference;
    /// \brief Type of a single immutable element.
    typedef detail::MatrixRowReference<const type> const_reference;
    
    
    /// \brief the iterator type of the object
    typedef ProxyIterator<type, value_type, reference > iterator;
    /// \brief the const_iterator type of the object
    typedef ProxyIterator<const type, value_type, const_reference > const_iterator;
    
    ///\brief creates a batch with input as size blueprint
    template<class Element>
    static type createBatch(Element const& input, std::size_t size = 1){
        return type(size,input.size());
    }
    ///\brief creates a batch storing the elements referenced by the provided range
    template<class Iterator>
    static type createBatchFromRange(Iterator const& start, Iterator const& end){
        //before creating the batch, we need the number of nonzero elements
        std::size_t nonzeros = 0;
        for(Iterator pos = start; pos != end; ++pos){
            nonzeros += pos->nnz();
        }
        
        type batch(end - start,start->size(),nonzeros);
        std::copy(start,end,begin(batch));
        return batch;
    }
    
    
    static void resize(type& batch, std::size_t batchSize, std::size_t elements){
        ensure_size(batch,batchSize,elements);
    }
    
    static std::size_t size(type const& batch){return batch.size1();}
    static reference get( type& batch, std::size_t i){
        return reference(batch,i);
    }
    static const_reference get( type const& batch, std::size_t i){
        return const_reference(batch,i);
    }
    
    static iterator begin(type& batch){
        return iterator(batch,0);
    }
    static const_iterator begin(type const& batch){
        return const_iterator(batch,0);
    }
    
    static iterator end(type& batch){
        return iterator(batch,batch.size1());
    }
    static const_iterator end(type const& batch){
        return const_iterator(batch,batch.size1());
    }
};

template<class M>
struct Batch<detail::MatrixRowReference<M> >
:public Batch<typename detail::MatrixRowReference<M>::Vector>{};


template<class BatchType>
struct BatchTraits{
    typedef Batch<typename std::decay<BatchType>::type::value_type> type;
};

template<class T>
struct BatchTraits<blas::matrix<T> >{
    typedef Batch<blas::vector<T> > type;
};
template<class T>
struct BatchTraits<blas::compressed_matrix<T> >{
    typedef Batch<blas::compressed_vector<T> > type;
};
template<class T>
struct BatchTraits<blas::dense_matrix_adaptor<T, blas::row_major> >{
    typedef detail::VectorBatch<blas::dense_matrix_adaptor<T, blas::row_major> > type;
};

namespace detail{
template<class T>
struct batch_to_element{
    typedef typename BatchTraits<T>::type::value_type type;
};
template<class T>
struct batch_to_element<T&>{
    //~ typedef typename BatchTraits<T>::type::reference type;
    typedef typename BatchTraits<T>::type::value_type type;
};
template<class T>
struct batch_to_element<T const&>{
    //~ typedef typename BatchTraits<T>::type::const_reference type;
    typedef typename BatchTraits<T>::type::value_type type;
};

template<class T>
struct batch_to_reference{
    typedef typename BatchTraits<T>::type::reference type;
};
template<class T>
struct batch_to_reference<T&>{
    typedef typename BatchTraits<T>::type::reference type;
};
template<class T>
struct batch_to_reference<T const&>{
    typedef typename BatchTraits<T>::type::const_reference type;
};

template<class T>
struct element_to_batch{
    typedef typename Batch<T>::type type;
};
template<class T>
struct element_to_batch<T&>{
    typedef typename Batch<T>::type& type;
};
template<class T>
struct element_to_batch<T const&>{
    typedef typename Batch<T>::type const& type;
};
template<class M>
struct element_to_batch<detail::MatrixRowReference<M> >{
    typedef typename Batch<typename detail::MatrixRowReference<M>::Vector>::type& type;
};
template<class M>
struct element_to_batch<detail::MatrixRowReference<M const> >{
    typedef typename Batch<typename detail::MatrixRowReference<M>::Vector>::type const& type;
};
}


///\brief creates a batch from a range of inputs
template<class T, class Range>
typename Batch<T>::type createBatch(Range const& range){
    return Batch<T>::createBatchFromRange(range.begin(),range.end());
}

///\brief creates a batch from a range of inputs
template<class Range>
typename Batch<typename Range::value_type>::type createBatch(Range const& range){
    return Batch<typename Range::value_type>::createBatchFromRange(range.begin(),range.end());
}

template<class T, class Iterator>
typename Batch<T>::type createBatch(Iterator const& begin, Iterator const& end){
    return Batch<T>::createBatchFromRange(begin,end);
}

template<class BatchT>
auto getBatchElement(BatchT& batch, std::size_t i)->decltype(BatchTraits<BatchT>::type::get(std::declval<BatchT&>(),i)){
    return BatchTraits<BatchT>::type::get(batch,i);
}

template<class BatchT>
auto getBatchElement(BatchT const& batch, std::size_t i)->decltype(BatchTraits<BatchT>::type::get(std::declval<BatchT const&>(),i)){
    return BatchTraits<BatchT>::type::get(batch,i);
}

template<class BatchT>
std::size_t batchSize(BatchT const& batch){
    return BatchTraits<BatchT>::type::size(batch);
}

template<class BatchT>
auto batchBegin(BatchT& batch)->decltype(BatchTraits<BatchT>::type::begin(batch)){
    return BatchTraits<BatchT>::type::begin(batch);
}

template<class BatchT>
auto batchBegin(BatchT const& batch)->decltype(BatchTraits<BatchT>::type::begin(batch)){
    return BatchTraits<BatchT>::type::begin(batch);
}

template<class BatchT>
auto batchEnd(BatchT& batch)->decltype(BatchTraits<BatchT>::type::end(batch)){
    return BatchTraits<BatchT>::type::end(batch);
}

template<class BatchT>
auto batchEnd(BatchT const& batch)->decltype(BatchTraits<BatchT>::type::end(batch)){
    return BatchTraits<BatchT>::type::end(batch);
}


}
#endif