dia_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/array2d.h>
#include <cusp/detail/format.h>
#include <cusp/detail/matrix_base.h>
#include <cusp/detail/utils.h>

namespace cusp
{

// Forward definitions
template <typename ArrayType1, typename ArrayType2, typename IndexType, typename ValueType, typename MemorySpace> class dia_matrix_view;

template <typename IndexType, typename ValueType, class MemorySpace>
class dia_matrix : public cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::dia_format>
{
private:

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

public:
    // TODO statically assert is_signed<IndexType>

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

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

    typedef typename cusp::dia_matrix_view<
            typename diagonal_offsets_array_type::view,
            typename values_array_type::view,
            IndexType, ValueType, MemorySpace> view;

    typedef typename cusp::dia_matrix_view<
            typename diagonal_offsets_array_type::const_view,
            typename values_array_type::const_view,
            IndexType, ValueType, MemorySpace> const_view;

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

    template<typename MemorySpace2>
    struct rebind
    {
        typedef cusp::dia_matrix<IndexType, ValueType, MemorySpace2> type;
    };
    diagonal_offsets_array_type diagonal_offsets;

    values_array_type values;

    dia_matrix(void) {}

    dia_matrix(const size_t num_rows, const size_t num_cols, const size_t num_entries,
               const size_t num_diagonals, const size_t alignment = 32);

    template <typename MatrixType>
    dia_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_diagonals);

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

    void swap(dia_matrix& matrix);

    template <typename MatrixType>
    dia_matrix& operator=(const MatrixType& matrix);
}; // class dia_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 dia_matrix_view : public cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::dia_format>
{
private:

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

public:
    typedef ArrayType1 diagonal_offsets_array_type;
    typedef ArrayType2 values_array_type;
    typedef typename cusp::dia_matrix<IndexType, ValueType, MemorySpace> container;
    typedef typename cusp::dia_matrix_view<ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace> view;
    typedef typename cusp::dia_matrix_view<ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace> const_view;

    typedef typename cusp::detail::coo_view_type<view,cusp::dia_format>::view       coo_view_type;
    typedef typename cusp::detail::coo_view_type<view const,cusp::dia_format>::view const_coo_view_type;
    diagonal_offsets_array_type diagonal_offsets;

    values_array_type values;

    dia_matrix_view(void) {}

    template <typename OtherArrayType1, typename OtherArrayType2>
    dia_matrix_view(size_t num_rows, size_t num_cols, size_t num_entries,
                    OtherArrayType1& diagonal_offsets, OtherArrayType2& values)
        : Parent(num_rows, num_cols, num_entries),
          diagonal_offsets(diagonal_offsets),
          values(values) {}

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

    dia_matrix_view(dia_matrix<IndexType,ValueType,MemorySpace>& matrix)
        : Parent(matrix),
          diagonal_offsets(make_array1d_view(matrix.diagonal_offsets)),
          values(make_array2d_view(matrix.values)) {}

    dia_matrix_view(const dia_matrix<IndexType,ValueType,MemorySpace>& matrix)
        : Parent(matrix),
          diagonal_offsets(make_array1d_view(matrix.diagonal_offsets)),
          values(make_array2d_view(matrix.values)) {}

    dia_matrix_view(dia_matrix_view& matrix)
        : Parent(matrix),
          diagonal_offsets(matrix.diagonal_offsets),
          values(matrix.values) {}

    dia_matrix_view(const dia_matrix_view& matrix)
        : Parent(matrix),
          diagonal_offsets(matrix.diagonal_offsets),
          values(matrix.values) {}

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

    void resize(const size_t num_rows, const size_t num_cols, const size_t num_entries,
                const size_t num_diagonals, const size_t alignment);
}; // class dia_matrix_view

/* Convenience functions */

template <typename ArrayType1,
         typename ArrayType2>
dia_matrix_view<ArrayType1,ArrayType2>
make_dia_matrix_view(size_t num_rows,
                     size_t num_cols,
                     size_t num_entries,
                     ArrayType1 diagonal_offsets,
                     ArrayType2 values)
{
    dia_matrix_view<ArrayType1,ArrayType2>
           view(num_rows, num_cols, num_entries, diagonal_offsets, values);

    return view;
}

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

template <typename IndexType, typename ValueType, class MemorySpace>
typename dia_matrix<IndexType,ValueType,MemorySpace>::view
make_dia_matrix_view(dia_matrix<IndexType,ValueType,MemorySpace>& m)
{
    return make_dia_matrix_view
           (m.num_rows, m.num_cols, m.num_entries,
            cusp::make_array1d_view(m.diagonal_offsets),
            cusp::make_array2d_view(m.values));
}

template <typename IndexType, typename ValueType, class MemorySpace>
typename dia_matrix<IndexType,ValueType,MemorySpace>::const_view
make_dia_matrix_view(const dia_matrix<IndexType,ValueType,MemorySpace>& m)
{
    return make_dia_matrix_view
           (m.num_rows, m.num_cols, m.num_entries,
            cusp::make_array1d_view(m.diagonal_offsets),
            cusp::make_array2d_view(m.values));
}

} // end namespace cusp

#include <cusp/detail/dia_matrix.inl>