permutation_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/detail/matrix_base.h>

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

namespace cusp
{

// forward definition
template <typename ArrayType, typename IndexType, typename MemorySpace> class permutation_matrix_view;

template <typename IndexType, typename MemorySpace>
class permutation_matrix : public cusp::detail::matrix_base<IndexType,IndexType,MemorySpace,cusp::permutation_format>
{
private:

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

public:

    typedef typename cusp::array1d<IndexType, MemorySpace> permutation_array_type;

    typedef typename cusp::permutation_matrix<IndexType, MemorySpace> container;

    typedef typename cusp::permutation_matrix_view<
            typename permutation_array_type::view,
            IndexType,
            MemorySpace> view;

    typedef typename cusp::permutation_matrix_view<
            typename permutation_array_type::const_view,
            IndexType,
            MemorySpace> const_view;

    template<typename MemorySpace2>
    struct rebind {
        typedef cusp::permutation_matrix<IndexType, MemorySpace2> type;
    };
    permutation_array_type permutation;

    permutation_matrix(void) {}

    permutation_matrix(const size_t num_rows)
        : Parent(num_rows, num_rows, num_rows),
          permutation(cusp::counting_array<int>(num_rows)) {}

    template<typename MemorySpace2>
    permutation_matrix(const permutation_matrix<IndexType,MemorySpace2>& matrix)
        : Parent(matrix), permutation(matrix.permutation) {}

    template<typename ArrayType>
    permutation_matrix(const size_t num_rows, const ArrayType& permutation)
        : Parent(num_rows, num_rows, num_rows), permutation(permutation) {}

    void resize(const size_t num_rows);

    void swap(permutation_matrix& matrix);

    template<typename MatrixType>
    void symmetric_permute(MatrixType& matrix);
}; // class permutation_matrix
template <typename ArrayType,
          typename IndexType   = typename ArrayType::value_type,
          typename MemorySpace = typename ArrayType::memory_space>
class permutation_matrix_view : public cusp::detail::matrix_base<IndexType,IndexType,MemorySpace,cusp::permutation_format>
{
private:

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

public:

    typedef ArrayType permutation_array_type;

    typedef typename cusp::permutation_matrix<IndexType, MemorySpace> container;

    typedef typename cusp::permutation_matrix_view<ArrayType, IndexType, MemorySpace> view;
    permutation_array_type permutation;

    permutation_matrix_view(void)
        : Parent() {}

    permutation_matrix_view(const size_t num_rows, ArrayType& permutation)
        : Parent(num_rows, num_rows, num_rows),
          permutation(permutation) {}

    permutation_matrix_view(const size_t num_rows, const ArrayType& permutation)
        : Parent(num_rows, num_rows, num_rows),
          permutation(permutation) {}

    permutation_matrix_view(permutation_matrix<IndexType,MemorySpace>& matrix)
        : Parent(matrix),
          permutation(matrix.permutation) {}

    permutation_matrix_view(const permutation_matrix<IndexType,MemorySpace>& matrix)
        : Parent(matrix),
          permutation(matrix.permutation) {}

    permutation_matrix_view(permutation_matrix_view<ArrayType>& matrix)
        : Parent(matrix),
          permutation(matrix.permutation) {}

    permutation_matrix_view(const permutation_matrix_view<ArrayType>& matrix)
        : Parent(matrix),
          permutation(matrix.permutation) {}

    void resize(const size_t num_rows);

    template<typename MatrixType>
    void symmetric_permute(MatrixType& matrix);
};

/* Convenience functions */

template <typename ArrayType>
permutation_matrix_view<ArrayType>
make_permutation_matrix_view(size_t num_rows, ArrayType permutation)
{
    permutation_matrix_view<ArrayType> view(num_rows, permutation);

    return view;
}

template <typename ArrayType, typename IndexType, typename MemorySpace>
permutation_matrix_view<ArrayType,IndexType,MemorySpace>
make_permutation_matrix_view(const permutation_matrix_view<ArrayType,IndexType,MemorySpace>& m)
{
    return permutation_matrix_view<ArrayType,IndexType,MemorySpace>(m);
}

template <typename IndexType, class MemorySpace>
typename permutation_matrix<IndexType,MemorySpace>::view
make_permutation_matrix_view(permutation_matrix<IndexType,MemorySpace>& m)
{
    return make_permutation_matrix_view(m.num_rows, make_array1d_view(m.permutation));
}

template <typename IndexType, class MemorySpace>
typename permutation_matrix<IndexType,MemorySpace>::const_view
make_permutation_matrix_view(const permutation_matrix<IndexType,MemorySpace>& m)
{
    return make_permutation_matrix_view(m.num_rows, make_array1d_view(m.permutation));
}
} // end namespace cusp

#include <cusp/detail/permutation_matrix.inl>