coo_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/detail/format.h>
#include <cusp/array1d.h>
#include <cusp/detail/matrix_base.h>

namespace cusp
{

// forward definition
template <typename ArrayType1, typename ArrayType2, typename ArrayType3,
          typename IndexType, typename ValueType, typename MemorySpace> class coo_matrix_view;
template <typename IndexType, typename ValueType, class MemorySpace>
class coo_matrix : public cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::coo_format>
{
private:

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

public:

    typedef typename cusp::array1d<IndexType, MemorySpace> row_indices_array_type;
    typedef typename cusp::array1d<IndexType, MemorySpace> column_indices_array_type;
    typedef typename cusp::array1d<ValueType, MemorySpace> values_array_type;

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

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

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

    typedef view        coo_view_type;
    typedef const_view  const const_coo_view_type;

    template<typename MemorySpace2>
    struct rebind
    {
        typedef cusp::coo_matrix<IndexType, ValueType, MemorySpace2> type;
    };
    row_indices_array_type row_indices;

    column_indices_array_type column_indices;

    values_array_type values;

    coo_matrix(void) {}

    coo_matrix(const size_t num_rows, const size_t num_cols, const size_t num_entries)
        : Parent(num_rows, num_cols, num_entries),
          row_indices(num_entries),
          column_indices(num_entries),
          values(num_entries) {}

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

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

    void swap(coo_matrix& matrix);

    template <typename MatrixType>
    coo_matrix& operator=(const MatrixType& matrix);

    void sort_by_row(void);

    void sort_by_row_and_column(void);

    bool is_sorted_by_row(void);

    bool is_sorted_by_row_and_column(void);
}; // class coo_matrix
template <typename ArrayType1,
          typename ArrayType2,
          typename ArrayType3,
          typename IndexType   = typename ArrayType2::value_type,
          typename ValueType   = typename ArrayType3::value_type,
          typename MemorySpace = typename cusp::minimum_space<
                                    typename ArrayType1::memory_space,
                                    typename ArrayType2::memory_space,
                                    typename ArrayType3::memory_space>::type >
class coo_matrix_view : public cusp::detail::matrix_base<IndexType,ValueType,MemorySpace,cusp::coo_format>
{
private:

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

public:

    typedef ArrayType1 row_indices_array_type;
    typedef ArrayType2 column_indices_array_type;
    typedef ArrayType3 values_array_type;

    typedef typename cusp::coo_matrix<IndexType, ValueType, MemorySpace> container;
    typedef typename cusp::coo_matrix_view<ArrayType1, ArrayType2, ArrayType3, IndexType, ValueType, MemorySpace> view;
    typedef typename cusp::coo_matrix_view<ArrayType1, ArrayType2, ArrayType3, IndexType, ValueType, MemorySpace> const_view;

    typedef view       coo_view_type;
    typedef view const const_coo_view_type;
    row_indices_array_type row_indices;

    column_indices_array_type column_indices;

    values_array_type values;

    cusp::array1d<typename thrust::detail::remove_const<IndexType>::type,MemorySpace> indices;

    coo_matrix_view(void)
        : Parent() {}

    coo_matrix_view(const size_t num_rows,
                    const size_t num_cols,
                    const size_t num_entries,
                    ArrayType1 row_indices,
                    ArrayType2 column_indices,
                    ArrayType3 values)
        : Parent(num_rows, num_cols, num_entries),
          row_indices(row_indices),
          column_indices(column_indices),
          values(values) {}

    coo_matrix_view(coo_matrix<IndexType,ValueType,MemorySpace>& matrix)
        : Parent(matrix),
          row_indices(matrix.row_indices),
          column_indices(matrix.column_indices),
          values(matrix.values) {}

    coo_matrix_view(const coo_matrix<IndexType,ValueType,MemorySpace>& matrix)
        : Parent(matrix),
          row_indices(matrix.row_indices),
          column_indices(matrix.column_indices),
          values(matrix.values) {}

    coo_matrix_view(view& matrix)
        : Parent(matrix),
          row_indices(matrix.row_indices),
          column_indices(matrix.column_indices),
          values(matrix.values),
          indices(matrix.indices) {}

    coo_matrix_view(const view& matrix)
        : Parent(matrix),
          row_indices(matrix.row_indices),
          column_indices(matrix.column_indices),
          values(matrix.values),
          indices(matrix.indices) {}

    template<typename MatrixType>
    coo_matrix_view(MatrixType& matrix);

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

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

    void sort_by_row(void);

    void sort_by_row_and_column(void);

    bool is_sorted_by_row(void);

    bool is_sorted_by_row_and_column(void);

protected:
    template<typename MatrixType>
    void construct_from(MatrixType& matrix, csr_format);

    template<typename MatrixType>
    void construct_from(MatrixType& matrix, dia_format);

    template<typename MatrixType>
    void construct_from(MatrixType& matrix, ell_format);

    template<typename MatrixType>
    void construct_from(MatrixType& matrix, hyb_format);
};

/* Convenience functions */

template <typename ArrayType1,
          typename ArrayType2,
          typename ArrayType3>
coo_matrix_view<ArrayType1,ArrayType2,ArrayType3>
make_coo_matrix_view(const size_t num_rows,
                     const size_t num_cols,
                     const size_t num_entries,
                     ArrayType1 row_indices,
                     ArrayType2 column_indices,
                     ArrayType3 values)
{
    coo_matrix_view<ArrayType1,ArrayType2,ArrayType3>
           view(num_rows, num_cols, num_entries, row_indices, column_indices, values);

    return view;
}

template <typename ArrayType1,
          typename ArrayType2,
          typename ArrayType3,
          typename IndexType,
          typename ValueType,
          typename MemorySpace>
coo_matrix_view<ArrayType1,ArrayType2,ArrayType3,IndexType,ValueType,MemorySpace>
make_coo_matrix_view(const coo_matrix_view<ArrayType1,ArrayType2,ArrayType3,IndexType,ValueType,MemorySpace>& m)
{
    return coo_matrix_view<ArrayType1,ArrayType2,ArrayType3,IndexType,ValueType,MemorySpace>(m);
}

template <typename MatrixType>
typename MatrixType::coo_view_type
make_coo_matrix_view(MatrixType& m)
{
    typedef typename MatrixType::coo_view_type View;

    return View(m);
}

template <typename MatrixType>
typename MatrixType::const_coo_view_type
make_coo_matrix_view(const MatrixType& m)
{
    typedef typename MatrixType::const_coo_view_type View;

    return View(m);
}
} // end namespace cusp

#include <cusp/detail/coo_matrix.inl>