SUNphi  1.0
SUNphi::Adder< _Refs > Class Template Reference

Class to add two SmET. More...

#include <Add.hpp>

Inheritance diagram for SUNphi::Adder< _Refs >:
SUNphi::BaseAdder SUNphi::NnarySmET< Adder< _Refs... > > SUNphi::ConstrainAreSmETs< _Refs... > SUNphi::SmET< Adder< _Refs... > > SUNphi::BaseNnarySmET SUNphi::BaseSmET SUNphi::BaseSmET

Public Types

enum  Pos_t { ADDEND1, ADDEND2 }
 Position of the references.
 
using Tk = BlendTensKinds< TkOf< Ref< ADDEND1 >>, TkOf< Ref< ADDEND2 >>>
 
using ExtraDelims = IntSeq<>
 
using PosOfResTcsInRefsTk = PosOfTcsOfTkInListOfTks< Tk, typename RemRef< _Refs >::Tk... >
 
using PosOfResTcsPresInRefsTk = PosOfTcsOfTkPresInListOfTks< Tk, typename RemRef< _Refs >::Tk... >
 
using Fund = decltype(_fundThroughRepresentativeFunction(IntsUpTo< NSmET >{}))
 
using MergeableComps = NnarySmETCompsMergeability< Tuple< typename RemRef< _Refs >::MergeableComps... >, PosOfResTcsInRefsTk, ExtraDelims >
 

Public Member Functions

template<typename TC , int I = 0>
int compSize () const
 
template<typename Tref >
bool isAliasing (const Tref &alias) const
 
decltype(auto) getMaximallyMergedCompsView ()
 
template<int... Is, typename MDs >
decltype(auto) mergedCompsViewAccordingToRepresentativeFunction (IntSeq< Is... >, MDs) const
 
template<typename... Ts>
decltype(auto) mergedCompsViewAccordingToRepresentativeFunction (Ts &&...ts)
 
template<typename Is >
decltype(auto) getMergedCompsView () const
 
template<typename... Ts>
decltype(auto) getMergedCompsView (Ts &&...ts)
 
template<typename... Args>
decltype(auto) eval (Args &&...args) const
 
template<typename... Ts>
decltype(auto) eval (Ts &&...ts)
 
template<typename... SMETS>
 Adder (SMETS &&...smets)
 
Adder< _Refs... > & operator~ ()
 
const Adder< _Refs... > & operator~ () const
 
decltype(auto) _refEvalByCompsName (IntSeq< I >, IntSeq< Pos... >, Tp &&targs) const
 < Components to get More...
 
decltype(auto) _refEvalByCompsName (Ts &&...ts)
 
decltype(auto) refEvalByCompsName (Tp &&targs) const
 < Components to get More...
 
decltype(auto) refEvalByCompsName (Tp &&targs)
 
decltype(auto) evalThroughRepresentativeFunctionPassingCompsByName (IntSeq< I... >, const Args &...args) const
 < Components to get More...
 
decltype(auto) evalThroughRepresentativeFunctionPassingCompsByName (Ts &&...ts)
 
decltype(auto) operator() (Oth &&...oth)
 
decltype(auto) operator() (Oth &&...oth) const
 

Static Public Member Functions

template<typename Addend1 , typename Addend2 >
static decltype(auto) representativeFunction (Addend1 &&addend1, Addend2 &&addend2)
 Representative function of the sum operation. More...
 
template<int... Is>
static decltype(auto) _fundThroughRepresentativeFunction (IntSeq< Is... >)
 
template<typename Is , typename = EnableIf<isIntSeq<Is>>>
static constexpr void assertMergeableWith ()
 

Static Public Attributes

static constexpr bool isStoring = false
 
static constexpr bool isAssignable
 

Private Types

using Refs = Tuple< _Refs... >
 
template<int I>
using Ref = TupleElementType< I, Tuple< _Refs... >>
 

Private Attributes

Tuple< Reference< _Refs >... > refs
 

Static Private Attributes

static constexpr int NSmET = 2
 

Detailed Description

template<typename... _Refs>
class SUNphi::Adder< _Refs >

Class to add two SmET.

Definition at line 20 of file Add.hpp.

Member Typedef Documentation

template<typename... _Refs>
using SUNphi::Adder< _Refs >::ExtraDelims = IntSeq<>

No Additional MergeDelims is included

Additional delimiters

Definition at line 55 of file Add.hpp.

template<typename... _Refs>
using SUNphi::Adder< _Refs >::Fund = decltype(_fundThroughRepresentativeFunction(IntsUpTo<NSmET>{}))

Obtains the Fund type by calling the representativeFunction

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
using SUNphi::Adder< _Refs >::MergeableComps = NnarySmETCompsMergeability< Tuple<typename RemRef<_Refs>::MergeableComps...>, PosOfResTcsInRefsTk, ExtraDelims>

List of points where the TensKind can be split

Using MergingDelimsForRefs and ExtraDelims to determine the mergability

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
using SUNphi::Adder< _Refs >::PosOfResTcsInRefsTk = PosOfTcsOfTkInListOfTks<Tk,typename RemRef<_Refs>::Tk...>

Position of all the Result TensComp in each Refs Tk

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
using SUNphi::Adder< _Refs >::PosOfResTcsPresInRefsTk = PosOfTcsOfTkPresInListOfTks<Tk,typename RemRef<_Refs>::Tk...>

Position of all the Result TensComp present in each Refs Tk

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
template<int I>
using SUNphi::Adder< _Refs >::Ref = TupleElementType<I,Tuple<_Refs...>>
private

Type of I-th SmET

Definition at line 26 of file Add.hpp.

template<typename... _Refs>
using SUNphi::Adder< _Refs >::Refs = Tuple<_Refs...>
private

Type of the binding references

Definition at line 26 of file Add.hpp.

template<typename... _Refs>
using SUNphi::Adder< _Refs >::Tk = BlendTensKinds<TkOf<Ref<ADDEND1>>,TkOf<Ref<ADDEND2>>>

TensKind of the result

Todo:
Improve, the return type could be decided studying what suits best the computational

Definition at line 53 of file Add.hpp.

Constructor & Destructor Documentation

template<typename... _Refs>
template<typename... SMETS>
SUNphi::Adder< _Refs >::Adder ( SMETS &&...  smets)
inlineexplicit

Constructor taking universal reference

Definition at line 59 of file Add.hpp.

Member Function Documentation

template<typename... _Refs>
template<int... Is>
static decltype(auto) SUNphi::Adder< _Refs >::_fundThroughRepresentativeFunction ( IntSeq< Is... >  )
inlinestatic

Fundamental type according to the representativeFunction

Internal implementation, getting the type through a call to

the representativeFunction passing by value the Fund

type of each ref, using an IntSeq to call them

Definition at line 57 of file Add.hpp.

decltype(auto) SUNphi::NnarySmET< Adder< _Refs... > >::_refEvalByCompsName ( IntSeq< I >  ,
IntSeq< Pos... >  ,
Tp &&  targs 
) const
inlineinherited

< Components to get

Evaluate the I-th reference, getting from the Tuple targs the element Pos

Internal implementation

Definition at line 54 of file NnarySmET.hpp.

decltype(auto) SUNphi::NnarySmET< Adder< _Refs... > >::_refEvalByCompsName ( Ts &&...  ts)
inlineinherited

Overload the _refEvalByCompsName const method passing all args

Parameters
tsArguments

Definition at line 61 of file NnarySmET.hpp.

template<typename... _Refs>
template<typename Is , typename = EnableIf<isIntSeq<Is>>>
static constexpr void SUNphi::Adder< _Refs >::assertMergeableWith ( )
inlinestatic

Assert that a given merging condition is valid

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
template<typename TC , int I = 0>
int SUNphi::Adder< _Refs >::compSize ( ) const
inline

Returns the size in the first found ref

TensKind of the I-th SmET

Check if the TensKind contains the TensComp asked

Definition at line 43 of file Add.hpp.

template<typename... _Refs>
template<typename... Args>
decltype(auto) SUNphi::Adder< _Refs >::eval ( Args &&...  args) const
inline

Evaluator, external interface

Evaluate the function by usign a method called

representativeFunction, to be provided in the clas

passing to it the evaluation of each individual reference,

dispatching the components id by the name they have in the

reference

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
template<typename... Ts>
decltype(auto) SUNphi::Adder< _Refs >::eval ( Ts &&...  ts)
inline

Overload the eval const method passing all args

Parameters
tsArguments

Definition at line 57 of file Add.hpp.

decltype(auto) SUNphi::NnarySmET< Adder< _Refs... > >::evalThroughRepresentativeFunctionPassingCompsByName ( IntSeq< I... >  ,
const Args &...  args 
) const
inlineinherited

< Components to get

Evaluate the result by calling a representative function

The result is obtained after splitting the components, identifying them trough the name of each TensComp

Definition at line 93 of file NnarySmET.hpp.

decltype(auto) SUNphi::NnarySmET< Adder< _Refs... > >::evalThroughRepresentativeFunctionPassingCompsByName ( Ts &&...  ts)
inlineinherited

Overload the evalThroughRepresentativeFunctionPassingCompsByName const method passing all args

Parameters
tsArguments

Definition at line 101 of file NnarySmET.hpp.

template<typename... _Refs>
decltype(auto) SUNphi::Adder< _Refs >::getMaximallyMergedCompsView ( )
inline

Returns the maximal possible merged comps view

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
template<typename Is >
decltype(auto) SUNphi::Adder< _Refs >::getMergedCompsView ( ) const
inline

Uses the representativeFunction to provide a merged view

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
template<typename... Ts>
decltype(auto) SUNphi::Adder< _Refs >::getMergedCompsView ( Ts &&...  ts)
inline

Overload the getMergedCompsView const method passing all args

Parameters
tsArguments

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
template<typename Tref >
bool SUNphi::Adder< _Refs >::isAliasing ( const Tref &  alias) const
inline

Forward aliasing check to the references

Definition at line 47 of file Add.hpp.

template<typename... _Refs>
template<typename... Ts>
decltype(auto) SUNphi::Adder< _Refs >::mergedCompsViewAccordingToRepresentativeFunction ( Ts &&...  ts)
inline

Overload the mergedCompsViewAccordingToRepresentativeFunction const method passing all args

Parameters
tsArguments

Definition at line 57 of file Add.hpp.

template<typename... _Refs>
template<int... Is, typename MDs >
decltype(auto) SUNphi::Adder< _Refs >::mergedCompsViewAccordingToRepresentativeFunction ( IntSeq< Is... >  ,
MDs   
) const
inline

Calls the representativeFunction with the merged view of each ref

Definition at line 57 of file Add.hpp.

decltype(auto) SUNphi::SmET< Adder< _Refs... > >::operator() ( Oth &&...  oth)
inlineinherited

Implements the call operator via CRTP

Parameters
othOther quantit

Definition at line 289 of file BaseSmET.hpp.

decltype(auto) SUNphi::SmET< Adder< _Refs... > >::operator() ( Oth &&...  oth) const
inlineinherited

Implements the const call operator via CRTP

< Other quantit

Definition at line 290 of file BaseSmET.hpp.

Adder< _Refs... > & SUNphi::NnarySmET< Adder< _Refs... > >::operator~ ( )
inlineinherited

Cast operator to class T

Definition at line 46 of file NnarySmET.hpp.

const Adder< _Refs... > & SUNphi::NnarySmET< Adder< _Refs... > >::operator~ ( ) const
inlineinherited

Constant cast operator to class T

Definition at line 46 of file NnarySmET.hpp.

decltype(auto) SUNphi::NnarySmET< Adder< _Refs... > >::refEvalByCompsName ( Tp &&  targs) const
inlineinherited

< Components to get

Evaluate the I-th reference, getting from the Tuple targs the element Pos

External implementation, using PosOfResTcsPresInRefsTk to dispatch components

Position of TensComp of the reference Tk present in thr result

Definition at line 68 of file NnarySmET.hpp.

decltype(auto) SUNphi::NnarySmET< Adder< _Refs... > >::refEvalByCompsName ( Tp &&  targs)
inlineinherited

Evaluate the I-th reference, getting from the Tuple targs the element Pos

Non const version

Definition at line 82 of file NnarySmET.hpp.

template<typename... _Refs>
template<typename Addend1 , typename Addend2 >
static decltype(auto) SUNphi::Adder< _Refs >::representativeFunction ( Addend1 &&  addend1,
Addend2 &&  addend2 
)
inlinestatic

Representative function of the sum operation.

Parameters
addend1First addend
addend2Second addend

Definition at line 37 of file Add.hpp.

Member Data Documentation

constexpr bool SUNphi::NnarySmET< Adder< _Refs... > >::isAssignable
staticinherited

Returns whether this SmET can be the left hand of an assignement

This SmET can never be lhs

Definition at line 44 of file NnarySmET.hpp.

template<typename... _Refs>
constexpr bool SUNphi::Adder< _Refs >::isStoring = false
static

Returns whether this SmET is storing

This SmET is not storing

Definition at line 46 of file Add.hpp.

template<typename... _Refs>
constexpr int SUNphi::Adder< _Refs >::NSmET = 2
staticprivate

Number or SmET to act upon

Definition at line 26 of file Add.hpp.

template<typename... _Refs>
Tuple<Reference<_Refs>...> SUNphi::Adder< _Refs >::refs
private

Reference to the 2 object

Definition at line 26 of file Add.hpp.


The documentation for this class was generated from the following file: