Commit c5c62221 authored by Praetorius, Simon's avatar Praetorius, Simon
Browse files

improved documentation and add header files to CMakeLists.txt

parent 27c9ec6b
...@@ -32,9 +32,11 @@ namespace AMDiS ...@@ -32,9 +32,11 @@ namespace AMDiS
} // end namespace Definition } // end namespace Definition
/// Vector component can be accessed either with [.] or (.)
template <class V, class I> template <class V, class I>
using VectorAccessible_t = bool_t<models<Definition::HasVectorAccess(V, I, Dune::PriorityTag<42>)>>; using VectorAccessible_t = bool_t<models<Definition::HasVectorAccess(V, I, Dune::PriorityTag<42>)>>;
/// Matrix component can be accessed either with [.][.] or (.,.)
template <class M, class I, class J> template <class M, class I, class J>
using MatrixAccessible_t = bool_t<models<Definition::HasMatrixAccess(M, I, J, Dune::PriorityTag<42>)>>; using MatrixAccessible_t = bool_t<models<Definition::HasMatrixAccess(M, I, J, Dune::PriorityTag<42>)>>;
...@@ -42,7 +44,7 @@ namespace AMDiS ...@@ -42,7 +44,7 @@ namespace AMDiS
#ifdef DOXYGEN #ifdef DOXYGEN
/// \brief Uniform vector access using [.] /// \brief Uniform vector access using [.] or (.)
template <class Vector, class I> template <class Vector, class I>
decltype(auto) access(Vector&& vec, I const& i); decltype(auto) access(Vector&& vec, I const& i);
...@@ -77,6 +79,7 @@ namespace AMDiS ...@@ -77,6 +79,7 @@ namespace AMDiS
} }
} }
// access i'th component of a vector
template <class Vector, class I> template <class Vector, class I>
decltype(auto) access(Vector&& vec, I const& i) decltype(auto) access(Vector&& vec, I const& i)
{ {
......
...@@ -4,6 +4,7 @@ dune_library_add_sources(amdis SOURCES ...@@ -4,6 +4,7 @@ dune_library_add_sources(amdis SOURCES
) )
install(FILES install(FILES
Access.hpp
Algorithm.hpp Algorithm.hpp
Apply.hpp Apply.hpp
Concepts.hpp Concepts.hpp
...@@ -13,6 +14,7 @@ install(FILES ...@@ -13,6 +14,7 @@ install(FILES
FieldMatVec.inc.hpp FieldMatVec.inc.hpp
Filesystem.hpp Filesystem.hpp
ForEach.hpp ForEach.hpp
HybridSize.hpp
Index.hpp Index.hpp
Literals.hpp Literals.hpp
Logical.hpp Logical.hpp
......
...@@ -15,9 +15,11 @@ namespace AMDiS ...@@ -15,9 +15,11 @@ namespace AMDiS
{ {
namespace Concepts namespace Concepts
{ {
/// Vector can be accessed with dynamic indices. See \ref VectorAccessible_t
template <class V> template <class V>
using DynamicVectorAccessible_t = VectorAccessible_t<V, std::size_t>; using DynamicVectorAccessible_t = VectorAccessible_t<V, std::size_t>;
/// Matrix can be accessed with dynamic indices. See \ref MatrixAccessible_t
template <class M> template <class M>
using DynamicMatrixAccessible_t = MatrixAccessible_t<M, std::size_t, std::size_t>; using DynamicMatrixAccessible_t = MatrixAccessible_t<M, std::size_t, std::size_t>;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment