ell_matrix.h

Go to the documentation of this file.

/*
 *  Copyright 2008-2014 NVIDIA Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

#pragma once

#include <cusp/detail/config.h>

#include <cusp/array1d.h>
#include <cusp/memory.h>

#include <cusp/detail/format.h>
#include <cusp/detail/matrix_base.h>
#include <cusp/detail/type_traits.h>
#include <cusp/detail/utils.h>

namespace cusp
{

// Forward definitions
struct column_major;

template<typename,typename,typename>                   class array2d;
template<typename,typename>                            class array2d_view;
template<typename,typename,typename,typename,typename> class ell_matrix_view;

template<typename T, class MemorySpace, class Orientation>
array2d_view<typename cusp::array1d_view<typename cusp::array1d<T,MemorySpace>::iterator>, Orientation>
make_array2d_view(cusp::array2d<T,MemorySpace,Orientation>& v);

template<typename T, class MemorySpace, class Orientation>
array2d_view<typename cusp::array1d_view<typename cusp::array1d<T,MemorySpace>::const_iterator>, Orientation>
make_array2d_view(const cusp::array2d<T,MemorySpace,Orientation>& v);
template <typename IndexType, typename ValueType, typename MemorySpace>
class ell_matrix : public cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::ell_format>
{
private:

    typedef cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::ell_format> Parent;

public:

    const static IndexType invalid_index = static_cast<IndexType>(-1);

    typedef typename cusp::array2d<IndexType, MemorySpace, cusp::column_major> column_indices_array_type;
    typedef typename cusp::array2d<ValueType, MemorySpace, cusp::column_major> values_array_type;

    typedef typename cusp::ell_matrix<IndexType, ValueType, MemorySpace>       container;

    typedef typename cusp::ell_matrix_view<
            typename column_indices_array_type::view,
            typename values_array_type::view,
            IndexType, ValueType, MemorySpace> view;

    typedef typename cusp::ell_matrix_view<
            typename column_indices_array_type::const_view,
            typename values_array_type::const_view,
            IndexType, ValueType, MemorySpace> const_view;

    typedef typename cusp::detail::coo_view_type<container, cusp::ell_format>::view                    coo_view_type;
    typedef typename cusp::detail::coo_view_type<container const, cusp::ell_format>::view              const_coo_view_type;

    template<typename MemorySpace2>
    struct rebind
    {
        typedef cusp::ell_matrix<IndexType, ValueType, MemorySpace2> type;
    };
    column_indices_array_type column_indices;

    values_array_type values;

    ell_matrix(void) {}

    ell_matrix(const size_t num_rows, const size_t num_cols, const size_t num_entries,
               const size_t num_entries_per_row, const size_t alignment = 32);

    template <typename MatrixType>
    ell_matrix(const MatrixType& matrix);

    void resize(const size_t num_rows, const size_t num_cols, const size_t num_entries,
                const size_t num_entries_per_row);

    void resize(const size_t num_rows, const size_t num_cols, const size_t num_entries,
                const size_t num_entries_per_row, const size_t alignment);

    void swap(ell_matrix& matrix);

    template <typename MatrixType>
    ell_matrix& operator=(const MatrixType& matrix);
}; // class ell_matrix
template <typename ArrayType1,
         typename ArrayType2,
         typename IndexType   = typename ArrayType1::value_type,
         typename ValueType   = typename ArrayType2::value_type,
         typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type >
class ell_matrix_view : public cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::ell_format>
{
private:

    typedef cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::ell_format> Parent;

public:

    typedef ArrayType1 column_indices_array_type;
    typedef ArrayType2 values_array_type;

    typedef cusp::ell_matrix<IndexType, ValueType, MemorySpace>                              container;
    typedef cusp::ell_matrix_view<ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace> view;
    typedef cusp::ell_matrix_view<ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace> const_view;

    typedef typename cusp::detail::coo_view_type<view,cusp::ell_format>::view       coo_view_type;
    typedef typename cusp::detail::coo_view_type<view const,cusp::ell_format>::view const_coo_view_type;
    const static IndexType invalid_index = container::invalid_index;

    column_indices_array_type column_indices;

    values_array_type values;

    ell_matrix_view(void) {}

    template <typename OtherArrayType1, typename OtherArrayType2>
    ell_matrix_view(const size_t num_rows, const size_t num_cols, const size_t num_entries,
                    const OtherArrayType1& column_indices, const OtherArrayType2& values)
        : Parent(num_rows, num_cols, num_entries),
          column_indices(column_indices),
          values(values) {}

    ell_matrix_view(ell_matrix<IndexType,ValueType,MemorySpace>& matrix)
        : Parent(matrix),
          column_indices(make_array2d_view(matrix.column_indices)),
          values(make_array2d_view(matrix.values)) {}

    ell_matrix_view(const ell_matrix<IndexType,ValueType,MemorySpace>& matrix)
        : Parent(matrix),
          column_indices(make_array2d_view(matrix.column_indices)),
          values(make_array2d_view(matrix.values)) {}

    ell_matrix_view(ell_matrix_view& matrix)
        : Parent(matrix),
          column_indices(matrix.column_indices),
          values(matrix.values) {}

    ell_matrix_view(const ell_matrix_view& matrix)
        : Parent(matrix),
          column_indices(matrix.column_indices),
          values(matrix.values) {}

    void resize(size_t num_rows, size_t num_cols, size_t num_entries,
                size_t num_entries_per_row);

    void resize(size_t num_rows, size_t num_cols, size_t num_entries,
                size_t num_entries_per_row, size_t alignment);
}; // class ell_matrix_view

template <typename ArrayType1, typename ArrayType2>
ell_matrix_view<ArrayType1,ArrayType2>
make_ell_matrix_view(size_t num_rows, size_t num_cols, size_t num_entries,
                     ArrayType1 column_indices, ArrayType2 values)
{
    ell_matrix_view<ArrayType1,ArrayType2>
           view(num_rows, num_cols, num_entries, column_indices, values);

    return view;
}

template <typename ArrayType1,
         typename ArrayType2,
         typename IndexType,
         typename ValueType,
         typename MemorySpace>
ell_matrix_view<ArrayType1,ArrayType2,IndexType,ValueType,MemorySpace>
make_ell_matrix_view(const ell_matrix_view<ArrayType1,ArrayType2,IndexType,ValueType,MemorySpace>& m)
{
    return ell_matrix_view<ArrayType1,ArrayType2,IndexType,ValueType,MemorySpace>(m);
}

template <typename IndexType, typename ValueType, typename MemorySpace>
typename ell_matrix<IndexType,ValueType,MemorySpace>::view
make_ell_matrix_view(ell_matrix<IndexType,ValueType,MemorySpace>& m)
{
    return make_ell_matrix_view
           (m.num_rows, m.num_cols, m.num_entries,
            cusp::make_array2d_view(m.column_indices),
            cusp::make_array2d_view(m.values));
}

template <typename IndexType, typename ValueType, typename MemorySpace>
typename ell_matrix<IndexType,ValueType,MemorySpace>::const_view
make_ell_matrix_view(const ell_matrix<IndexType,ValueType,MemorySpace>& m)
{
    return make_ell_matrix_view
           (m.num_rows, m.num_cols, m.num_entries,
            cusp::make_array2d_view(m.column_indices),
            cusp::make_array2d_view(m.values));
}

} // end namespace cusp

#include <cusp/detail/ell_matrix.inl>