From 8a0fdf7a7cdc73ab5b2721121522cabcef42ee8f Mon Sep 17 00:00:00 2001 From: Christian Zimmermann Date: Sat, 3 Feb 2024 23:21:40 +0100 Subject: [PATCH] improve comment notation + add missing briefs --- src/include/array/aindex.cc.h | 5 +- src/include/array/aindex.h | 5 +- src/include/array/array_base.cc.h | 5 +- src/include/array/array_base.h | 5 +- src/include/array/marray.cc.h | 5 +- src/include/array/marray.h | 5 +- src/include/array/slice.cc.h | 5 +- src/include/array/slice.h | 5 +- src/include/base/types.h | 4 +- src/include/memory/memcount.h | 5 +- src/include/memory/memory.cc.h | 5 +- src/include/memory/memory.h | 5 +- src/include/operation/basic_operations.cc.h | 18 +++---- src/include/operation/extensions/avx.cc.h | 24 ++++----- src/include/operation/extensions/reg.cc.h | 24 ++++----- src/include/operation/extensions/reg.h | 36 +++++++------- src/include/ranges/crange.cc.h | 5 +- src/include/ranges/dindex.cc.h | 3 +- src/include/ranges/dindex.h | 2 +- src/include/ranges/eindex.cc.h | 5 +- src/include/ranges/eindex.h | 3 +- src/include/ranges/index_base.cc.h | 17 +++---- src/include/ranges/index_base.h | 5 +- src/include/ranges/index_format.cc.h | 23 +++++---- src/include/ranges/index_mul.cc.h | 21 ++++---- src/include/ranges/index_pack.cc.h | 29 ++++++----- src/include/ranges/lindex.cc.h | 3 +- src/include/ranges/range_base.cc.h | 5 +- src/include/ranges/ranges.cc.h | 5 +- src/include/ranges/srange.cc.h | 29 ++++++----- src/include/ranges/urange.cc.h | 29 ++++++----- src/include/ranges/xindex.cc.h | 11 ++--- src/include/xpr/for.cc.h | 48 +++++++++--------- src/include/xpr/pos_type.cc.h | 54 ++++++++++----------- src/include/xpr/pos_type.h | 12 ++--- src/include/xpr/vpos_type.cc.h | 30 ++++++------ src/include/xpr/xpr_base.cc.h | 12 ++--- src/lib/ranges/range_base.cc | 18 +++---- src/lib/ranges/yrange.cc | 42 ++++++++-------- src/opt/cereal/include/cer_ranges.cc.h | 12 ++--- 40 files changed, 279 insertions(+), 305 deletions(-) diff --git a/src/include/array/aindex.cc.h b/src/include/array/aindex.cc.h index ac45c4a..e28c257 100644 --- a/src/include/array/aindex.cc.h +++ b/src/include/array/aindex.cc.h @@ -2,10 +2,9 @@ /** @file include/array/aindex.cc.h - @brief ... + @brief Array index template implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/array/aindex.h b/src/include/array/aindex.h index 0352376..7f7a411 100644 --- a/src/include/array/aindex.h +++ b/src/include/array/aindex.h @@ -2,10 +2,9 @@ /** @file include/array/aindex.h - @brief ... + @brief Array index declaration. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/array/array_base.cc.h b/src/include/array/array_base.cc.h index ae1218f..cd71cdf 100644 --- a/src/include/array/array_base.cc.h +++ b/src/include/array/array_base.cc.h @@ -2,10 +2,9 @@ /** @file include/array/array_base.cc.h - @brief ... + @brief Array base class template implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/array/array_base.h b/src/include/array/array_base.h index f74f83b..9e3ad07 100644 --- a/src/include/array/array_base.h +++ b/src/include/array/array_base.h @@ -2,10 +2,9 @@ /** @file include/array/array_base.h - @brief ... + @brief Array base class declarations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/array/marray.cc.h b/src/include/array/marray.cc.h index 3ea3923..d60b07d 100644 --- a/src/include/array/marray.cc.h +++ b/src/include/array/marray.cc.h @@ -2,10 +2,9 @@ /** @file include/array/marray.cc.h - @brief ... + @brief MArray implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/array/marray.h b/src/include/array/marray.h index 9445ec7..384cacb 100644 --- a/src/include/array/marray.h +++ b/src/include/array/marray.h @@ -2,10 +2,9 @@ /** @file include/array/marray.h - @brief ... + @brief MArray declarations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/array/slice.cc.h b/src/include/array/slice.cc.h index 1dca0cf..95131b9 100644 --- a/src/include/array/slice.cc.h +++ b/src/include/array/slice.cc.h @@ -2,10 +2,9 @@ /** @file include/array/slice.cc.h - @brief ... + @brief Slice implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/array/slice.h b/src/include/array/slice.h index a636b1a..fab06da 100644 --- a/src/include/array/slice.h +++ b/src/include/array/slice.h @@ -2,10 +2,9 @@ /** @file include/array/slice.h - @brief ... + @brief Slice declarations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/base/types.h b/src/include/base/types.h index 77dbc98..9ba70d3 100644 --- a/src/include/base/types.h +++ b/src/include/base/types.h @@ -84,7 +84,7 @@ namespace CNORXZ | library types | +===================*/ - /*** + /* Naming Prefixes: D = Y = Dynamic V = X = Virtual @@ -100,7 +100,7 @@ namespace CNORXZ A = (const) Array B = (mutable) Array F = Functional, Map,... - ***/ + */ // default template parameter class None {}; diff --git a/src/include/memory/memcount.h b/src/include/memory/memcount.h index f69c261..6dc9268 100644 --- a/src/include/memory/memcount.h +++ b/src/include/memory/memcount.h @@ -2,10 +2,9 @@ /** @file include/memory/memcount.h - @brief ... + @brief MemCount declaration. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/memory/memory.cc.h b/src/include/memory/memory.cc.h index 19a1181..82ffc2f 100644 --- a/src/include/memory/memory.cc.h +++ b/src/include/memory/memory.cc.h @@ -2,10 +2,9 @@ /** @file include/memory/memory.cc.h - @brief ... + @brief Memory template implementations main header. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/memory/memory.h b/src/include/memory/memory.h index 6f1ec8c..85be208 100644 --- a/src/include/memory/memory.h +++ b/src/include/memory/memory.h @@ -2,10 +2,9 @@ /** @file include/memory/memory.h - @brief ... + @brief Memory main heade. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/operation/basic_operations.cc.h b/src/include/operation/basic_operations.cc.h index df23e01..49d937c 100644 --- a/src/include/operation/basic_operations.cc.h +++ b/src/include/operation/basic_operations.cc.h @@ -16,9 +16,9 @@ namespace CNORXZ { - /************************************ - * standard operatrions (unary) * - ************************************/ + /*==================================+ + | standard operatrions (unary) | + +==================================*/ template constexpr decltype(auto) minus(const COpInterface& op) @@ -26,9 +26,9 @@ namespace CNORXZ return operation( [](const auto& a) { return -a; }, op.THIS() ); } - /************************************* - * standard operatrions (binary) * - *************************************/ + /*===================================+ + | standard operatrions (binary) | + +===================================*/ template constexpr decltype(auto) plus(const COpInterface& op1, const COpInterface& op2) @@ -65,9 +65,9 @@ namespace CNORXZ op1.THIS(), op2.THIS() ); } - /***************************************** - * operators for standard operations * - *****************************************/ + /*=======================================+ + | operators for standard operations | + +=======================================*/ template constexpr decltype(auto) operator-(const COpInterface& op) diff --git a/src/include/operation/extensions/avx.cc.h b/src/include/operation/extensions/avx.cc.h index 51328d5..88c0020 100644 --- a/src/include/operation/extensions/avx.cc.h +++ b/src/include/operation/extensions/avx.cc.h @@ -16,9 +16,9 @@ namespace CNORXZ { - /*********************** - * PlusCC / PlusCX * - ***********************/ + /*=====================+ + | PlusCC / PlusCX | + +=====================*/ inline decltype(auto) PlusCC::eval(const Consecutive& a, @@ -80,9 +80,9 @@ namespace CNORXZ return o; } - /************************* - * MinusCC / MinusCX * - *************************/ + /*=======================+ + | MinusCC / MinusCX | + +=======================*/ inline decltype(auto) MinusCC::eval(const Consecutive& a, @@ -144,9 +144,9 @@ namespace CNORXZ return o; } - /*********************************** - * MultipliesCC / MultipliesCX * - ***********************************/ + /*=================================+ + | MultipliesCC / MultipliesCX | + +=================================*/ inline decltype(auto) MultipliesCC::eval(const Consecutive& a, @@ -210,9 +210,9 @@ namespace CNORXZ } - /***************************** - * DividesCC / DividesCX * - *****************************/ + /*===========================+ + | DividesCC / DividesCX | + +===========================*/ inline decltype(auto) DividesCC::eval(const Consecutive& a, diff --git a/src/include/operation/extensions/reg.cc.h b/src/include/operation/extensions/reg.cc.h index 39465d0..f3d85fb 100644 --- a/src/include/operation/extensions/reg.cc.h +++ b/src/include/operation/extensions/reg.cc.h @@ -120,9 +120,9 @@ namespace CNORXZ return consecFuncAI(f, dst, args..., std::make_index_sequence{}); } - /****************************** - * basic operations: plus * - ******************************/ + /*============================+ + | basic operations: plus | + +============================*/ template constexpr decltype(auto) @@ -156,9 +156,9 @@ namespace CNORXZ return consecFuncA( [](auto& x, const auto& y) { return x += y; }, o, a ); } - /******************************* - * basic operations: minus * - *******************************/ + /*=============================+ + | basic operations: minus | + +=============================*/ template constexpr decltype(auto) MinusCC::eval(const Consecutive& a, const Consecutive& b) @@ -190,9 +190,9 @@ namespace CNORXZ return consecFuncA( [](auto& x, const auto& y) { return x -= y; }, o, a ); } - /*********************************** - * basic operations: muliplies * - ***********************************/ + /*=================================+ + | basic operations: muliplies | + +=================================*/ template constexpr decltype(auto) MultipliesCC::eval(const Consecutive& a, const Consecutive& b) @@ -224,9 +224,9 @@ namespace CNORXZ return consecFuncA( [](const auto& x, const auto& y) { return x *= y; }, o, a ); } - /********************************* - * basic operations: divides * - *********************************/ + /*===============================+ + | basic operations: divides | + +===============================*/ template constexpr decltype(auto) DividesCC::eval(const Consecutive& a, const Consecutive& b) diff --git a/src/include/operation/extensions/reg.h b/src/include/operation/extensions/reg.h index 89cf05a..8cbf699 100644 --- a/src/include/operation/extensions/reg.h +++ b/src/include/operation/extensions/reg.h @@ -43,9 +43,9 @@ namespace CNORXZ template struct consecutive_size> { static constexpr SizeT value = N; }; - /**************************************** - * consecutive generating functions * - ****************************************/ + /*======================================+ + | consecutive generating functions | + +======================================*/ template inline decltype(auto) vregi(const T* d, const EPosT& pos, std::index_sequence is); @@ -56,9 +56,9 @@ namespace CNORXZ template inline decltype(auto) vreg(T* d, const EPosT& pos); - /****************** - * ConsecFunc * - ******************/ + /*================+ + | ConsecFunc | + +================*/ template constexpr decltype(auto) consecGet(const T& a); @@ -86,9 +86,9 @@ namespace CNORXZ template constexpr Dst& consecFuncA(const F& f, Dst& dst, const Args&... args); - /****************************** - * basic operations: plus * - ******************************/ + /*============================+ + | basic operations: plus | + +============================*/ template struct PlusCC @@ -133,9 +133,9 @@ namespace CNORXZ constexpr Consecutive& operator+=(Consecutive& o, const U& a) { return PlusCX::aeval(o,a); } - /******************************* - * basic operations: minus * - *******************************/ + /*=============================+ + | basic operations: minus | + +=============================*/ template struct MinusCC @@ -180,9 +180,9 @@ namespace CNORXZ constexpr Consecutive& operator-=(Consecutive& o, const U& a) { return MinusCX::eval(o,a); } - /*********************************** - * basic operations: muliplies * - ***********************************/ + /*=================================+ + | basic operations: muliplies | + +=================================*/ template struct MultipliesCC @@ -227,9 +227,9 @@ namespace CNORXZ constexpr Consecutive& operator*=(Consecutive& o, const U& a) { return MultipliesCX::eval(o,a); } - /********************************* - * basic operations: divides * - *********************************/ + /*===============================+ + | basic operations: divides | + +===============================*/ template struct DividesCC diff --git a/src/include/ranges/crange.cc.h b/src/include/ranges/crange.cc.h index 6a8e3be..843b90b 100644 --- a/src/include/ranges/crange.cc.h +++ b/src/include/ranges/crange.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/crange.cc.h - @brief ... + @brief CRange and CIndex template implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/ranges/dindex.cc.h b/src/include/ranges/dindex.cc.h index f752bed..91668b6 100644 --- a/src/include/ranges/dindex.cc.h +++ b/src/include/ranges/dindex.cc.h @@ -2,8 +2,7 @@ /** @file include/ranges/dindex.cc.h - @brief ... - + @brief Dynamic index template implementations. Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de diff --git a/src/include/ranges/dindex.h b/src/include/ranges/dindex.h index 82cab3c..f70a56c 100644 --- a/src/include/ranges/dindex.h +++ b/src/include/ranges/dindex.h @@ -2,7 +2,7 @@ /** @file include/ranges/dindex.h - @brief DIndex declaration. + @brief Dynamic index declaration. Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de diff --git a/src/include/ranges/eindex.cc.h b/src/include/ranges/eindex.cc.h index e0c31c1..a48a8c3 100644 --- a/src/include/ranges/eindex.cc.h +++ b/src/include/ranges/eindex.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/eindex.cc.h - @brief ... + @brief Extension index implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/ranges/eindex.h b/src/include/ranges/eindex.h index f7e2c81..a0e1e3e 100644 --- a/src/include/ranges/eindex.h +++ b/src/include/ranges/eindex.h @@ -2,8 +2,7 @@ /** @file include/ranges/eindex.h - @brief ... - + @brief Extension index declaration. Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de diff --git a/src/include/ranges/index_base.cc.h b/src/include/ranges/index_base.cc.h index 4ba1774..c037b54 100644 --- a/src/include/ranges/index_base.cc.h +++ b/src/include/ranges/index_base.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/index_base.cc.h - @brief ... + @brief Index base template implementation. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ @@ -17,9 +16,9 @@ namespace CNORXZ { - /********************** - * IndexInterface * - **********************/ + /*====================+ + | IndexInterface | + +====================*/ template IndexInterface::IndexInterface() @@ -113,9 +112,9 @@ namespace CNORXZ } - /**************************** - * Non-member functions * - ****************************/ + /*==========================+ + | Non-member functions | + +==========================*/ template IndexPtr& operator++(const IndexPtr& i) diff --git a/src/include/ranges/index_base.h b/src/include/ranges/index_base.h index 4668af8..e9ca374 100644 --- a/src/include/ranges/index_base.h +++ b/src/include/ranges/index_base.h @@ -2,10 +2,9 @@ /** @file include/ranges/index_base.h - @brief ... + @brief Index base declaration. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/ranges/index_format.cc.h b/src/include/ranges/index_format.cc.h index b5fa845..7acf07c 100644 --- a/src/include/ranges/index_format.cc.h +++ b/src/include/ranges/index_format.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/index_format.cc.h - @brief ... + @brief Index formats implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ @@ -17,9 +16,9 @@ namespace CNORXZ { - /*************** - * MFormat * - ***************/ + /*=============+ + | MFormat | + +=============*/ template constexpr MFormat::MFormat(const Arr& b) : @@ -61,9 +60,9 @@ namespace CNORXZ } - /**************** - * GMFormat * - ****************/ + /*==============+ + | GMFormat | + +==============*/ template constexpr GMFormat::GMFormat(const Tuple& b) : @@ -115,9 +114,9 @@ namespace CNORXZ return GMFormat(std::move(std::make_tuple(ps...))); } - /*************** - * YFormat * - ***************/ + /*=============+ + | YFormat | + +=============*/ template YFormat::YFormat(const FormatT& f) : mB(f.size()) diff --git a/src/include/ranges/index_mul.cc.h b/src/include/ranges/index_mul.cc.h index 0395560..dbc1e7a 100644 --- a/src/include/ranges/index_mul.cc.h +++ b/src/include/ranges/index_mul.cc.h @@ -2,8 +2,7 @@ /** @file include/ranges/index_mul.cc.h - @brief ... - + @brief Index multiplication template implementation. Copyright (c) 2022 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de @@ -18,9 +17,9 @@ namespace CNORXZ { - /********************* - * MIndexSptrMul * - *********************/ + /*===================+ + | MIndexSptrMul | + +===================*/ template decltype(auto) MIndexSptrMul::evalMX(const Sptr>& a, @@ -52,9 +51,9 @@ namespace CNORXZ } - /***************** - * operator* * - *****************/ + /*===============+ + | operator* | + +===============*/ template inline decltype(auto) operator*(const IndexInterface& a, @@ -122,9 +121,9 @@ namespace CNORXZ return a.mul(b); } - /*************** - * iptrMul * - ***************/ + /*=============+ + | iptrMul | + +=============*/ template decltype(auto) iptrMul(const Sptr& a, const Sptr& b) diff --git a/src/include/ranges/index_pack.cc.h b/src/include/ranges/index_pack.cc.h index f8b05f5..c8be6aa 100644 --- a/src/include/ranges/index_pack.cc.h +++ b/src/include/ranges/index_pack.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/index_pack.cc.h - @brief ... + @brief Index pack template implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ @@ -17,9 +16,9 @@ namespace CNORXZ { - /************* - * SPack * - *************/ + /*===========+ + | SPack | + +===========*/ template constexpr SPack::SPack(const Sptr&... is) : @@ -96,9 +95,9 @@ namespace CNORXZ return lex(); } - /************************** - * SPack (non-member) * - **************************/ + /*========================+ + | SPack (non-member) | + +========================*/ template constexpr decltype(auto) spack(const Indices&... inds) @@ -114,9 +113,9 @@ namespace CNORXZ return SPack( inds... ); } - /************* - * DPack * - *************/ + /*===========+ + | DPack | + +===========*/ template DPack::DPack(const SPack& p) : @@ -127,9 +126,9 @@ namespace CNORXZ {} - /************************** - * DPack (non-member) * - **************************/ + /*========================+ + | DPack (non-member) | + +========================*/ template DPack dpack(const Indices&... inds) diff --git a/src/include/ranges/lindex.cc.h b/src/include/ranges/lindex.cc.h index 4dc5dab..5ec5342 100644 --- a/src/include/ranges/lindex.cc.h +++ b/src/include/ranges/lindex.cc.h @@ -2,8 +2,7 @@ /** @file include/ranges/lindex.cc.h - @brief ... - + @brief LIndex implementations. Copyright (c) 2022 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de diff --git a/src/include/ranges/range_base.cc.h b/src/include/ranges/range_base.cc.h index 779d871..d354056 100644 --- a/src/include/ranges/range_base.cc.h +++ b/src/include/ranges/range_base.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/range_base.cc.h - @brief ... + @brief RangeBase template implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/ranges/ranges.cc.h b/src/include/ranges/ranges.cc.h index 9f4f18f..5110bca 100644 --- a/src/include/ranges/ranges.cc.h +++ b/src/include/ranges/ranges.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/ranges.cc.h - @brief ... + @brief Ranges template implementation main header - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ diff --git a/src/include/ranges/srange.cc.h b/src/include/ranges/srange.cc.h index a5e9e55..7c9dfde 100644 --- a/src/include/ranges/srange.cc.h +++ b/src/include/ranges/srange.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/srange.cc.h - @brief ... + @brief SRange, SRangeFactory and SIndex implementation. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ @@ -18,9 +17,9 @@ namespace CNORXZ { - /************** - * SIndex * - **************/ + /*============+ + | SIndex | + +============*/ template SIndex::SIndex(const RangePtr& range, SizeT pos) : @@ -213,9 +212,9 @@ namespace CNORXZ } - /********************* - * SRangeFactory * - *********************/ + /*===================+ + | SRangeFactory | + +===================*/ template SRangeFactory::SRangeFactory(const Arr& space) : @@ -248,9 +247,9 @@ namespace CNORXZ } } - /************** - * SRange * - **************/ + /*============+ + | SRange | + +============*/ template SRange::SRange(const Arr& space) : @@ -338,9 +337,9 @@ namespace CNORXZ return Vector { this->id() }; } - /******************* - * Range Casts * - *******************/ + /*=================+ + | Range Casts | + +=================*/ template Sptr> RangeCast>::func(const RangePtr& r) diff --git a/src/include/ranges/urange.cc.h b/src/include/ranges/urange.cc.h index 603d096..7b868b5 100644 --- a/src/include/ranges/urange.cc.h +++ b/src/include/ranges/urange.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/urange.cc.h - @brief ... + @brief URange, URangeFactory and UIndex implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ @@ -25,9 +24,9 @@ namespace CNORXZ { - /***************** - * UIndex * - *****************/ + /*===============+ + | UIndex | + +===============*/ template UIndex::UIndex(const RangePtr& range, SizeT pos) : @@ -222,9 +221,9 @@ namespace CNORXZ return iptrMul(a, b); } - /********************** - * URangeFactory * - **********************/ + /*====================+ + | URangeFactory | + +====================*/ template URangeFactory::URangeFactory(const Vector& space) : @@ -257,9 +256,9 @@ namespace CNORXZ } } - /*************** - * URange * - ***************/ + /*=============+ + | URange | + +=============*/ template URange::URange(const Vector& space) : @@ -350,9 +349,9 @@ namespace CNORXZ return Vector { this->id() }; } - /******************* - * Range Casts * - *******************/ + /*=================+ + | Range Casts | + +=================*/ template struct URangeCast diff --git a/src/include/ranges/xindex.cc.h b/src/include/ranges/xindex.cc.h index ff5db88..f72e7c2 100644 --- a/src/include/ranges/xindex.cc.h +++ b/src/include/ranges/xindex.cc.h @@ -2,10 +2,9 @@ /** @file include/ranges/xindex.cc.h - @brief ... + @brief XIndexBase and XIndex template implementations. - - Copyright (c) 2022 Christian Zimmermann. All rights reserved. + Copyright (c) 2024 Christian Zimmermann. All rights reserved. Mail: chizeta@f3l.de **/ @@ -18,9 +17,9 @@ namespace CNORXZ { - /************** - * XIndex * - **************/ + /*============+ + | XIndex | + +============*/ template XIndex::XIndex(const IndexPtr& i) : diff --git a/src/include/xpr/for.cc.h b/src/include/xpr/for.cc.h index ba6a07e..5b95eb5 100644 --- a/src/include/xpr/for.cc.h +++ b/src/include/xpr/for.cc.h @@ -19,9 +19,9 @@ namespace CNORXZ { - /*********** - * For * - ***********/ + /*=========+ + | For | + +=========*/ template constexpr For::For(SizeT size, const IndexId& id, const Xpr& xpr, F&& f) : @@ -83,9 +83,9 @@ namespace CNORXZ return mXpr.rootSteps(id); } - /************************ - * For (non-member) * - ************************/ + /*======================+ + | For (non-member) | + +======================*/ template constexpr decltype(auto) mkFor(SizeT size, const IndexId& id, const Xpr& xpr, F&& f) @@ -99,9 +99,9 @@ namespace CNORXZ return For(size, id, xpr, NoF {}); } - /************ - * SFor * - ************/ + /*==========+ + | SFor | + +==========*/ template constexpr SFor::SFor(const IndexId& id, const Xpr& xpr, F&& f) : @@ -203,9 +203,9 @@ namespace CNORXZ return; } - /************************* - * SFor (non-member) * - *************************/ + /*=======================+ + | SFor (non-member) | + +=======================*/ template constexpr decltype(auto) mkSFor(const IndexId& id, const Xpr& xpr, F&& f) @@ -219,9 +219,9 @@ namespace CNORXZ return SFor(id, xpr, NoF {}); } - /************ - * PFor * - ************/ + /*==========+ + | PFor | + +==========*/ template constexpr PFor::PFor(SizeT size, const IndexId& id1, const IndexId& id2, @@ -291,9 +291,9 @@ namespace CNORXZ return mXpr.rootSteps(id); } - /************************* - * PFor (non-member) * - *************************/ + /*=======================+ + | PFor (non-member) | + +=======================*/ template constexpr decltype(auto) mkPFor(SizeT size, const IndexId& id1, const IndexId& id2, @@ -309,9 +309,9 @@ namespace CNORXZ return PFor(size, id1, id2, xpr, NoF {}); } - /************ - * TFor * - ************/ + /*==========+ + | TFor | + +==========*/ template constexpr TFor::TFor(SizeT size, const IndexId& id, const Xpr& xpr, F&& f) : @@ -399,9 +399,9 @@ namespace CNORXZ } - /************ - * EFor * - ************/ + /*==========+ + | EFor | + +==========*/ template constexpr EFor::EFor(const IndexId& id, const Xpr& xpr, F&& f) : diff --git a/src/include/xpr/pos_type.cc.h b/src/include/xpr/pos_type.cc.h index f4ade10..7fead30 100644 --- a/src/include/xpr/pos_type.cc.h +++ b/src/include/xpr/pos_type.cc.h @@ -18,9 +18,9 @@ namespace CNORXZ { - /************ - * SPos * - ************/ + /*==========+ + | SPos | + +==========*/ template constexpr SizeT SPos::size() const @@ -116,9 +116,9 @@ namespace CNORXZ return val(); } - /************ - * UPos * - ************/ + /*==========+ + | UPos | + +==========*/ constexpr UPos::UPos(SizeT ext) : mExt(ext) {} @@ -183,9 +183,9 @@ namespace CNORXZ return val(); } - /************ - * FPos * - ************/ + /*==========+ + | FPos | + +==========*/ inline FPos::FPos(SizeT ext, const SizeT* map) : mExt(ext), mMap(map) {} @@ -234,9 +234,9 @@ namespace CNORXZ return val(); } - /************* - * SFPos * - *************/ + /*===========+ + | SFPos | + +===========*/ template Arr SFPos::sMs = { Ms... }; @@ -320,9 +320,9 @@ namespace CNORXZ return val(); } - /************ - * MPos * - ************/ + /*==========+ + | MPos | + +==========*/ template constexpr MPos::MPos() @@ -411,9 +411,9 @@ namespace CNORXZ return extend(a); } - /************ - * DPos * - ************/ + /*==========+ + | DPos | + +==========*/ inline DPos::DPos(Uptr&& a) : ObjHandle(std::forward>(a)) @@ -516,9 +516,9 @@ namespace CNORXZ return val(); } - /*************** - * DPosRef * - ***************/ + /*=============+ + | DPosRef | + +=============*/ inline DPosRef::DPosRef(const VPosBase* p) : mP(p) {} @@ -597,9 +597,9 @@ namespace CNORXZ return val(); } - /************ - * EPos * - ************/ + /*==========+ + | EPos | + +==========*/ template constexpr EPos::EPos(const BPosT& b, const OPosTs&... os) : @@ -689,9 +689,9 @@ namespace CNORXZ return OEPosT(BPosT::next(), std::get(mP).next()...); } - /********************************* - * Traits and Helper-Classes * - *********************************/ + /*===============================+ + | Traits and Helper-Classes | + +===============================*/ template decltype(auto) MkEPos::mk(const BPosT& a, const OPosT& b) diff --git a/src/include/xpr/pos_type.h b/src/include/xpr/pos_type.h index 1817726..09f300e 100644 --- a/src/include/xpr/pos_type.h +++ b/src/include/xpr/pos_type.h @@ -306,9 +306,9 @@ namespace CNORXZ constexpr decltype(auto) get() const; }; - /********************************* - * Traits and Helper-Classes * - *********************************/ + /*===============================+ + | Traits and Helper-Classes | + +===============================*/ template struct is_pos_type { CXZ_CVAL_FALSE; }; @@ -380,9 +380,9 @@ namespace CNORXZ template decltype(auto) mkiEPos(const BPosT& a, const OPosT& b, std::index_sequence is); - /************************************************** - * Traits and Helper-Classes: Specializations * - **************************************************/ + /*================================================+ + | Traits and Helper-Classes: Specializations | + +================================================*/ template struct is_pos_type> { CXZ_CVAL_TRUE; }; template struct is_scalar_pos_type> { CXZ_CVAL_TRUE; }; diff --git a/src/include/xpr/vpos_type.cc.h b/src/include/xpr/vpos_type.cc.h index 4df2dc1..bb80df1 100644 --- a/src/include/xpr/vpos_type.cc.h +++ b/src/include/xpr/vpos_type.cc.h @@ -17,9 +17,9 @@ namespace CNORXZ { - /************ - * VPos * - ************/ + /*==========+ + | VPos | + +==========*/ template VPos::VPos(const PosT& a) : @@ -77,9 +77,9 @@ namespace CNORXZ return std::make_unique>( (*this)(UPos(a->vval())) ); } - /****************** - * VPos * - ******************/ + /*================+ + | VPos | + +================*/ template VPos>::VPos(const VPos& a) : @@ -168,9 +168,9 @@ namespace CNORXZ return std::make_unique>( (*this)(UPos(a->vval())) ); } - /*************** - * VPosRef * - ***************/ + /*=============+ + | VPosRef | + +=============*/ template VPosRef::VPosRef(const PosT* c) : @@ -228,9 +228,9 @@ namespace CNORXZ return std::make_unique>( (*mC)(UPos(a->vval())) ); } - /********************* - * VPosRef * - *********************/ + /*===================+ + | VPosRef | + +===================*/ template VPosRef>::VPosRef(const MPos* c) : @@ -298,9 +298,9 @@ namespace CNORXZ return std::make_unique>( (*mC)(UPos(a->vval())) ); } - /******************* - * PosFromVPos * - *******************/ + /*=================+ + | PosFromVPos | + +=================*/ template inline decltype(auto) PosFromVPos::make(const VPosBase* a) diff --git a/src/include/xpr/xpr_base.cc.h b/src/include/xpr/xpr_base.cc.h index 43fdf6c..f51afa2 100644 --- a/src/include/xpr/xpr_base.cc.h +++ b/src/include/xpr/xpr_base.cc.h @@ -17,9 +17,9 @@ namespace CNORXZ { - /************ - * VXpr * - ************/ + /*==========+ + | VXpr | + +==========*/ template VXpr::VXpr(const XprInterface& a) : @@ -50,9 +50,9 @@ namespace CNORXZ return DPos(this->rootSteps(id)); } - /************ - * DXpr * - ************/ + /*==========+ + | DXpr | + +==========*/ template template diff --git a/src/lib/ranges/range_base.cc b/src/lib/ranges/range_base.cc index 749c5f7..eb20116 100644 --- a/src/lib/ranges/range_base.cc +++ b/src/lib/ranges/range_base.cc @@ -15,9 +15,9 @@ namespace CNORXZ { - /************************* - * RangeFactoryBase * - *************************/ + /*=======================+ + | RangeFactoryBase | + +=======================*/ Map,RangePtr>> RangeFactoryBase::sCreated; @@ -56,9 +56,9 @@ namespace CNORXZ return rx; } - /****************** - * RangeBase * - ******************/ + /*================+ + | RangeBase | + +================*/ RangeBase::RangeBase() { @@ -101,9 +101,9 @@ namespace CNORXZ return this->index(this->size()); } - /**************************** - * Non-member functions * - ****************************/ + /*==========================+ + | Non-member functions | + +==========================*/ RangePack::operator RangePtr() const { diff --git a/src/lib/ranges/yrange.cc b/src/lib/ranges/yrange.cc index 0f799b9..4a4ac16 100644 --- a/src/lib/ranges/yrange.cc +++ b/src/lib/ranges/yrange.cc @@ -14,9 +14,9 @@ namespace CNORXZ { - /************************* - * YIndex (private) * - *************************/ + /*=======================+ + | YIndex (private) | + +=======================*/ inline DPack YIndex::mkIndices() const { @@ -130,9 +130,9 @@ namespace CNORXZ } - /*************** - * YIndex * - ***************/ + /*=============+ + | YIndex | + +=============*/ YIndex::YIndex(const YIndex& i) : IndexInterface>(i), @@ -517,9 +517,9 @@ namespace CNORXZ } - /**************************** - * non-member functions * - ****************************/ + /*==========================+ + | non-member functions | + +==========================*/ YIndex yindex(const DPack& pack) { @@ -541,9 +541,9 @@ namespace CNORXZ return std::make_shared(is); } - /********************** - * YRangeFactory * - **********************/ + /*====================+ + | YRangeFactory | + +====================*/ YRangeFactory::YRangeFactory(const Vector& rvec) : mRVec(rvec) {} @@ -570,9 +570,9 @@ namespace CNORXZ } } - /*************** - * YRange * - ***************/ + /*=============+ + | YRange | + +=============*/ RangePtr YRange::sub(SizeT i) const { @@ -659,18 +659,18 @@ namespace CNORXZ YRange::YRange(Vector&& rvec) : mRVec(std::forward>(rvec)) {} - /**************************** - * non-member functions * - ****************************/ + /*==========================+ + | non-member functions | + +==========================*/ RangePtr yrange(const Vector& rs) { return YRangeFactory(rs).create(); } - /******************* - * Range Casts * - *******************/ + /*=================+ + | Range Casts | + +=================*/ Sptr RangeCast::func(const RangePtr& r) { diff --git a/src/opt/cereal/include/cer_ranges.cc.h b/src/opt/cereal/include/cer_ranges.cc.h index 7180e99..4f23494 100644 --- a/src/opt/cereal/include/cer_ranges.cc.h +++ b/src/opt/cereal/include/cer_ranges.cc.h @@ -22,9 +22,9 @@ namespace CNORXZ { - /************** - * save * - **************/ + /*============+ + | save | + +============*/ template void save(Archive& ar, const Uuid& id) @@ -61,9 +61,9 @@ namespace CNORXZ ar(cereal::make_nvp("sub", mRVec)); } - /************** - * load * - **************/ + /*============+ + | load | + +============*/ template void load(Archive& ar, Uuid& id)