views.hpp

Go to the documentation of this file.

// vim: set tabstop=2:softtabstop=2:shiftwidth=2:expandtab

//
// MIT License
//
// Copyright (c) 2020 kylekrol
// Copyright (c) 2020 Pathfinder for Autonomous Navigation (PAN)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//

#ifndef LIN_VIEWS_HPP_
#define LIN_VIEWS_HPP_

#include "core.hpp"
#include "views/const_matrix_view.hpp"
#include "views/const_vector_view.hpp"
#include "views/matrix_view.hpp"
#include "views/vector_view.hpp"

#include <type_traits>

namespace lin {
namespace internal {

template <class C, typename = void>
struct view { };

template <class C>
using view_t = typename view<C>::type;

template <class C>
struct view<C, std::enable_if_t<is_matrix<C>::value>> {
  typedef MatrixView<typename C::Traits::elem_t, C::Traits::rows, C::Traits::cols, C::Traits::max_rows, C::Traits::max_cols> type;
};

template <class C>
struct view<C, std::enable_if_t<is_col_vector<C>::value>> {
  typedef VectorView<typename C::VectorTraits::elem_t, C::VectorTraits::length, C::VectorTraits::max_length> type;
};

template <class C>
struct view<C, std::enable_if_t<is_row_vector<C>::value>> {
  typedef RowVectorView<typename C::VectorTraits::elem_t, C::VectorTraits::length, C::VectorTraits::max_length> type;
};

template <class C, typename = void>
struct const_view { };

template <class C>
using const_view_t = typename const_view<C>::type;

template <class C>
struct const_view<C, std::enable_if_t<is_matrix<C>::value>> {
  typedef ConstMatrixView<typename C::Traits::elem_t, C::Traits::rows, C::Traits::cols, C::Traits::max_rows, C::Traits::max_cols> type;
};

template <class C>
struct const_view<C, std::enable_if_t<is_col_vector<C>::value>> {
  typedef ConstVectorView<typename C::VectorTraits::elem_t, C::VectorTraits::length, C::VectorTraits::max_length> type;
};

template <class C>
struct const_view<C, std::enable_if_t<is_row_vector<C>::value>> {
  typedef ConstRowVectorView<typename C::VectorTraits::elem_t, C::VectorTraits::length, C::VectorTraits::max_length> type;
};
}  // namespace internal

template <class C, typename = std::enable_if_t<internal::has_traits<C>::value>>
constexpr auto view(typename C::Traits::elem_t *elems) {
  return internal::view_t<C>(elems);
}

template <class C, typename = std::enable_if_t<internal::conjunction<
    internal::has_traits<C>, internal::is_vector<C>>::value>>
constexpr auto view(typename C::Traits::elem_t *elems, size_t n) {
  return internal::view_t<C>(elems, n);
}

template <class C, typename = std::enable_if_t<internal::has_traits<C>::value>>
constexpr auto view(typename C::Traits::elem_t *elems, size_t r, size_t c) {
  return internal::view_t<C>(elems, r, c);
}

template <class C, typename = std::enable_if_t<internal::has_traits<C>::value>>
constexpr auto view(typename C::Traits::elem_t const *elems) {
  return internal::const_view_t<C>(elems);
}

template <class C, typename = std::enable_if_t<internal::conjunction<
    internal::has_traits<C>, internal::is_vector<C>>::value>>
constexpr auto view(typename C::Traits::elem_t const *elems, size_t n) {
  return internal::const_view_t<C>(elems, n);
}

template <class C, typename = std::enable_if_t<internal::has_traits<C>::value>>
constexpr auto view(typename C::Traits::elem_t const *elems, size_t r, size_t c) {
  return internal::const_view_t<C>(elems, r, c);
}
}  // namespace lin

#endif