Skip to content
Snippets Groups Projects
Commit 89708c20 authored by Jakub Klinkovský's avatar Jakub Klinkovský
Browse files

Edited documentation for getView methods in Array and Vector

parent b7f168c4
No related branches found
No related tags found
1 merge request!33Allocators
......@@ -298,9 +298,9 @@ class Array
/**
* \brief Returns a modifiable view of the array.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* array is returned.
* By default, a view for the whole array is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the array sub-interval. It is 0 by
* default.
......@@ -312,9 +312,9 @@ class Array
/**
* \brief Returns a non-modifiable view of the array.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* array is returned.
* By default, a view for the whole array is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the array sub-interval. It is 0 by
* default.
......@@ -326,9 +326,9 @@ class Array
/**
* \brief Returns a non-modifiable view of the array.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* array is returned.
* By default, a view for the whole array is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the array sub-interval. It is 0 by
* default.
......
......@@ -157,9 +157,9 @@ public:
/**
* \brief Returns a modifiable view of the array view.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* array view is returned.
* By default, a view for the whole array is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the array view sub-interval. It is 0 by
* default.
......@@ -172,9 +172,9 @@ public:
/**
* \brief Returns a non-modifiable view of the array view.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* array view is returned.
* By default, a view for the whole array is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the array view sub-interval. It is 0 by
* default.
......@@ -183,13 +183,13 @@ public:
*/
__cuda_callable__
ConstViewType getView( const IndexType begin = 0, IndexType end = 0 ) const;
/**
* \brief Returns a non-modifiable view of the array view.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* array view is returned.
* By default, a view for the whole array is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the array view sub-interval. It is 0 by
* default.
......
......@@ -78,9 +78,9 @@ public:
/**
* \brief Returns a modifiable view of the vector.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* vector is returned.
* By default, a view for the whole vector is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the vector sub-interval. It is 0 by
* default.
......@@ -92,9 +92,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* vector is returned.
* By default, a view for the whole vector is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the vector sub-interval. It is 0 by
* default.
......@@ -106,9 +106,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* vector is returned.
* By default, a view for the whole vector is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the vector sub-interval. It is 0 by
* default.
......
......@@ -69,9 +69,9 @@ public:
/**
* \brief Returns a modifiable view of the vector view.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* vector view is returned.
* By default, a view for the whole vector is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the vector view sub-interval. It is 0 by
* default.
......@@ -84,9 +84,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector view.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* vector view is returned.
* By default, a view for the whole vector is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the vector view sub-interval. It is 0 by
* default.
......@@ -99,9 +99,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector view.
*
* If \e begin or \e end is set to a non-zero value, a view for the
* sub-interval `[begin, end)` is returned. Otherwise a view for whole
* vector view is returned.
* By default, a view for the whole vector is returned. If \e begin or
* \e end is set to a non-zero value, a view only for the sub-interval
* `[begin, end)` is returned.
*
* \param begin The beginning of the vector view sub-interval. It is 0 by
* default.
......
......@@ -13,6 +13,7 @@
namespace TNL {
// TODO: remove - not used anywhere
template< typename T >
struct ViewTypeGetter
{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment