Commit 652f848c authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

removed obsolete references to contxx

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/branches/libfourier
SVN Revision: 3938
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 7cbb8c90
......@@ -38,6 +38,8 @@
* - 11/12/2002 V1.1 introduced mixed type operatrions
* - 15/12/2002 V1.2 (thof)
* - no need to place this in namespace prebuilt
* - 14/05/2011 V1.3 (thof)
* - removed reference to libcontxx in documentation
*
* ============================================================================
*/
......@@ -46,7 +48,7 @@
#ifndef AFF_RAWARFUN_H_VERSION
#define AFF_RAWARFUN_H_VERSION \
"AFF_RAWARFUN_H V1.2"
"AFF_RAWARFUN_H V1.3"
#define AFF_RAWARFUN_H_CVSID \
"$Id$"
......@@ -122,9 +124,9 @@ namespace util {
* =A_{0}+B_{0}\;(A_{1}+B_{1}\;(A_{2}+\ldots))
* \f$
*
* This is used to calculate offset values for the dense strided
* This is used to calculate offset values for the strided
* shape.
* \sa contxx::shape::DenseStrided
* \sa aff::Strided
*/
static inline T strideproduct(const T* A, const T* B)
{
......@@ -204,9 +206,9 @@ namespace util {
* =A_{0}+B_{0}\;(A_{1}+B_{1}\;(A_{2}+\ldots))
* \f$
*
* This is used to calculate offset values for the dense strided
* This is used to calculate offset values for the strided
* shape.
* \sa contxx::shape::DenseStrided
* \sa aff::Strided
*/
static inline T1 strideproduct(const T1* A, const T2* B)
{
......
......@@ -34,6 +34,8 @@
* - no need to place this into namespace prebuilt
* - 10/12/2007 V1.3 (thof)
* - checked initializer
* - 14/05/2011 V1.4 (thof)
* - reworked documentation
*
* ============================================================================
*/
......@@ -42,7 +44,7 @@
#ifndef AFF_SIMPLEARRAY_H_VERSION
#define AFF_SIMPLEARRAY_H_VERSION \
"AFF_SIMPLEARRAY_H V1.3"
"AFF_SIMPLEARRAY_H V1.4"
#define AFF_SIMPLEARRAY_H_CVSID \
"$Id$"
......@@ -62,26 +64,18 @@ using namespace aff::util;
* The arrays used for this purpose should be rigid, i.e. their dimension is
* defined during compile time and they usually perform no heap allocation
* on their own (an thus may also be used with stack memory).
* contxx::util::SimpleRigidArray serves for this purpose.
* aff::util::SimpleRigidArray serves for this purpose.
*
* \anchor anchor_simplerigigarray
* \note
* To pass index values to a contxx::Array (during construction or access),
* To pass index values to a aff::Array (during construction or access),
* we pass a SimpleRigidArray of appropriate dimension \c N. To fill this
* array we would either need to provide specializations with the
* appropriate number of constructor arguments or fill each element after
* the other.
* Both approaches range from inconvenient to impossible.
* To solve this problem the library provides a set of template functions
* contxx::shape::tuple.
* They are a simple tool to create a SimpleRigidArray.
* If you need a SimpleRidigArray<int,3> initialized with {3,8,2}, just code
* the construct
* \code
* contxx::shape::tuple(int(3),8,2)
* \endcode
* This function returns exactly the SimpleRigidArray object you need.
* For an example see tests/arraytest.cc
*
* For examples to use SimpleRigidArray see tests/simplearraytest.cc
*
* \note
* If you use the default constructor, the values are uninitialized. There
......@@ -90,6 +84,12 @@ using namespace aff::util;
* \param T element type
* \param N dimension of the array
*
* Functions to manipulate SimpleRigidArray objects are provided in
* aff::util::Inline and aff::util::Inline2 which are presented in
* lib/rawarfun.h
*
* \sa aff::util::Inline, aff::util::Inline2
*
* \todo
* Rework this documentation in particular with respect to scoping
*/
......
......@@ -87,9 +87,6 @@ namespace aff {
* arrays. This is in contrast to packed layouts for banded matrices or
* triangular matrices that do not hold every array element.
*
* See contxx::shape::Shape for a description of the common interface for
* all shapes.
*
* \note
* dimension index is 0,1,2,... (zero-based) when calling size(i) member
* function e.g.
......
......@@ -41,6 +41,9 @@
* - 09/01/2003 V1.5 (thof)
* - now throws exception in case of too many
* concatenated bracket operators
* - 14/05/2011 V1.6 (thof)
* - removed obsolete reference to libcontxx in
* documentation
*
* ============================================================================
*/
......@@ -49,7 +52,7 @@
#ifndef AFF_SHAPER_H_VERSION
#define AFF_SHAPER_H_VERSION \
"AFF_SHAPER_H V1.5"
"AFF_SHAPER_H V1.6"
#define AFF_SHAPER_H_CVSID \
"$Id$"
......@@ -59,22 +62,6 @@
namespace aff {
/*! \brief Shaper class for Fortran layout
*
* To create the equivalent to the Fortran declaration statement
* \code
* integer a1(0:4,-5:5), a2(5,5,8)
* \endcode
* write
* \code
* contxx::Array<int, 2> a1(contxx::shaper::Fortran<2>(0,4)(-5,5));
* contxx::Array<int, 3> a2(contxx::shaper::Fortran<3>(5)(5)(8));
* \endcode
*
* Using only one bracket
* \code
* contxx::Array<int, 3> a3(contxx::shaper::Fortran<3>(-10,10));
* \endcode
* will set all dimensions to index range [-10:10].
*
* \todo
* rework documentation of class Shaper
......
Markdown is supported
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