Cyclops Tensor Framework
parallel arithmetic on multidimensional arrays
Public Member Functions | Data Fields
CTF_int::Term Class Referenceabstract
Tensor expression compiler

a term is an abstract object representing some expression of tensors More...

#include <term.h>

Inheritance diagram for CTF_int::Term:
Inheritance graph
[legend]
Collaboration diagram for CTF_int::Term:
Collaboration graph
[legend]

Public Member Functions

 Term (algstrct const *sr)
 
virtual ~Term ()
 
virtual Term * clone (std::map< tensor *, tensor * > *remap=NULL) const =0
 base classes must implement this copy function to retrieve pointer More...
 
virtual void execute (CTF::Idx_Tensor output) const =0
 evalues the expression, which just scales by default More...
 
virtual double estimate_time (CTF::Idx_Tensor output) const =0
 estimates the cost of a contraction/sum/.. term More...
 
virtual CTF::Idx_Tensor estimate_time (double &cost, std::vector< char > out_inds) const =0
 estimates the cost the expression to produce an intermediate with all expression indices remaining More...
 
virtual CTF::Idx_Tensor execute (std::vector< char > out_inds) const =0
 evalues the expression to produce an intermediate with all expression indices remaining More...
 
virtual std::vector< char > get_uniq_inds () const =0
 find list of unique indices that are involved in this term More...
 
virtual void get_inputs (std::set< CTF::Idx_Tensor *, tensor_name_less > *inputs_set) const =0
 appends the tensors this depends on to the input set More...
 
void mult_scl (char const *mulscl)
 multiply scaling factor by mulscl More...
 
Contract_Term operator* (Term const &A) const
 constructs a new term which multiplies by tensor A More...
 
Contract_Term operator* (int64_t scl) const
 multiples by a constant More...
 
Contract_Term operator* (double scl) const
 
Sum_Term operator+ (Term const &A) const
 constructs a new term by addition of two terms More...
 
Sum_Term operator+ (double scl) const
 
Sum_Term operator+ (int64_t scl) const
 
Sum_Term operator- (Term const &A) const
 constructs a new term by subtracting term A More...
 
Sum_Term operator- (double scl) const
 
Sum_Term operator- (int64_t scl) const
 
Term & operator- ()
 
void operator= (CTF::Idx_Tensor const &B)
 A = B, compute any operations on operand B and set. More...
 
void operator= (Term const &B)
 
void operator+= (Term const &B)
 
void operator-= (Term const &B)
 
void operator*= (Term const &B)
 
void operator= (double scl)
 
void operator+= (double scl)
 
void operator<< (CTF_int::Term const &B)
 
void operator<< (double scl)
 
void operator-= (double scl)
 
void operator*= (double scl)
 
void operator= (int64_t scl)
 
void operator+= (int64_t scl)
 
void operator-= (int64_t scl)
 
void operator*= (int64_t scl)
 
void operator= (int scl)
 
void operator+= (int scl)
 
void operator-= (int scl)
 
void operator*= (int scl)
 
virtual CTF::World * where_am_i () const =0
 figures out what world this term lives on More...
 
 operator float () const
 cast to float (works only if tensor type is castable to float) allows a scalar output More...
 
 operator double () const
 cast to double (works only if tensor type is castable to double) allows a scalar output More...
 
 operator int64_t () const
 cast to int64_t (works only if tensor type is castable to int64_t) allows a scalar output More...
 
 operator int () const
 cast to int64_t (works only if tensor type is castable to int64_t) allows a scalar output More...
 

Data Fields

char * scale
 
algstrct * sr
 

Detailed Description

a term is an abstract object representing some expression of tensors

Definition at line 33 of file term.h.

Constructor & Destructor Documentation

CTF_int::Term::Term ( algstrct const *  sr)

Definition at line 202 of file term.cxx.

References CTF_int::algstrct::clone(), and ctf.core::scale().

CTF_int::Term::~Term ( )
virtual

Definition at line 208 of file term.cxx.

References CTF_int::cdealloc(), and ctf.core::scale().

Member Function Documentation

virtual Term* CTF_int::Term::clone ( std::map< tensor *, tensor * > *  remap = NULL) const
pure virtual

base classes must implement this copy function to retrieve pointer

Implemented in CTF_int::Contract_Term, CTF::Typ_Idx_Tensor< dtype >, CTF::Typ_Idx_Tensor< dtype_C >, CTF_int::Sum_Term, CTF_int::Bifun_Term, CTF_int::Unifun_Term, and CTF::Idx_Tensor.

Referenced by CTF_int::Bifun_Term::Bifun_Term(), CTF::TensorOperation::execute(), CTF_int::univar_function::operator()(), CTF_int::bivar_function::operator()(), operator*(), CTF_int::Contract_Term::operator*(), CTF::Idx_Tensor::operator*=(), operator+(), CTF_int::Sum_Term::operator+(), CTF::Idx_Tensor::operator+=(), operator-(), CTF_int::Sum_Term::operator-(), CTF::Idx_Tensor::operator-=(), CTF::Idx_Tensor::operator=(), and CTF_int::Unifun_Term::Unifun_Term().

virtual double CTF_int::Term::estimate_time ( CTF::Idx_Tensor  output) const
pure virtual

estimates the cost of a contraction/sum/.. term

Parameters
[in]outputtensor to write results into and its indices

Implemented in CTF_int::Contract_Term, CTF_int::Sum_Term, CTF::Idx_Tensor, CTF_int::Bifun_Term, and CTF_int::Unifun_Term.

Referenced by CTF_int::contract_down_terms(), CTF_int::Unifun_Term::estimate_time(), CTF_int::Bifun_Term::estimate_time(), CTF_int::Sum_Term::estimate_time(), and CTF_int::Contract_Term::estimate_time().

virtual CTF::Idx_Tensor CTF_int::Term::estimate_time ( double &  cost,
std::vector< char >  out_inds 
) const
pure virtual

estimates the cost the expression to produce an intermediate with all expression indices remaining

Parameters
[in,out]costthe cost of the operation
[in]out_indsunique indices to not contract/sum away
Returns
output tensor to write results into and its indices

Implemented in CTF_int::Contract_Term, CTF_int::Sum_Term, CTF::Idx_Tensor, CTF_int::Bifun_Term, and CTF_int::Unifun_Term.

virtual void CTF_int::Term::execute ( CTF::Idx_Tensor  output) const
pure virtual

evalues the expression, which just scales by default

Parameters
[in,out]outputtensor to write results into and its indices

Implemented in CTF_int::Contract_Term, CTF_int::Sum_Term, CTF::Idx_Tensor, CTF_int::Bifun_Term, and CTF_int::Unifun_Term.

Referenced by CTF_int::contract_down_terms(), CTF_int::Unifun_Term::execute(), CTF_int::Bifun_Term::execute(), CTF_int::Sum_Term::execute(), CTF_int::Contract_Term::execute(), CTF_int::endomorphism::operator()(), CTF_int::bivar_function::operator()(), CTF_int::univar_function::operator()(), CTF::Idx_Tensor::operator+=(), CTF::Idx_Tensor::operator-=(), operator<<(), and CTF::Idx_Tensor::operator=().

virtual CTF::Idx_Tensor CTF_int::Term::execute ( std::vector< char >  out_inds) const
pure virtual

evalues the expression to produce an intermediate with all expression indices remaining

Parameters
[in]out_indsunique indices to not contract/sum away

Implemented in CTF_int::Contract_Term, CTF_int::Sum_Term, CTF_int::Bifun_Term, CTF::Idx_Tensor, and CTF_int::Unifun_Term.

virtual void CTF_int::Term::get_inputs ( std::set< CTF::Idx_Tensor *, tensor_name_less > *  inputs_set) const
pure virtual

appends the tensors this depends on to the input set

Implemented in CTF_int::Contract_Term, CTF_int::Sum_Term, CTF_int::Bifun_Term, and CTF_int::Unifun_Term.

Referenced by CTF_int::Unifun_Term::get_inputs(), and CTF_int::Bifun_Term::get_inputs().

virtual std::vector<char> CTF_int::Term::get_uniq_inds ( ) const
pure virtual

find list of unique indices that are involved in this term

Returns
out_inds unique indices to not contract/sum away

Implemented in CTF_int::Contract_Term, CTF_int::Sum_Term, CTF::Idx_Tensor, CTF_int::Bifun_Term, and CTF_int::Unifun_Term.

Referenced by CTF_int::Bifun_Term::estimate_time(), CTF_int::Bifun_Term::execute(), CTF_int::Unifun_Term::get_uniq_inds(), CTF_int::Bifun_Term::get_uniq_inds(), CTF_int::endomorphism::operator()(), CTF_int::bivar_function::operator()(), and CTF_int::univar_function::operator()().

void CTF_int::Term::mult_scl ( char const *  mulscl)

multiply scaling factor by mulscl

Definition at line 216 of file term.cxx.

References ctf.core::scale().

CTF_int::Term::operator double ( ) const

cast to double (works only if tensor type is castable to double) allows a scalar output

Definition at line 295 of file term.cxx.

References CTF_int::CommData::bcast(), CTF::World::cdt, CTF_int::tensor::data, CTF_int::get_double_ring(), and CTF_int::tensor::wrld.

CTF_int::Term::operator float ( ) const

cast to float (works only if tensor type is castable to float) allows a scalar output

Definition at line 286 of file term.cxx.

References CTF_int::CommData::bcast(), CTF::World::cdt, CTF_int::tensor::data, CTF_int::get_float_ring(), and CTF_int::tensor::wrld.

CTF_int::Term::operator int ( ) const

cast to int64_t (works only if tensor type is castable to int64_t) allows a scalar output

Definition at line 314 of file term.cxx.

References CTF_int::CommData::bcast(), CTF::World::cdt, CTF_int::tensor::data, CTF_int::get_int_ring(), and CTF_int::tensor::wrld.

CTF_int::Term::operator int64_t ( ) const

cast to int64_t (works only if tensor type is castable to int64_t) allows a scalar output

Definition at line 323 of file term.cxx.

References CTF_int::CommData::bcast(), CTF::World::cdt, CTF_int::tensor::data, CTF_int::get_int64_t_ring(), and CTF_int::tensor::wrld.

Contract_Term CTF_int::Term::operator* ( Term const &  A) const

constructs a new term which multiplies by tensor A

Parameters
[in]Aterm to multiply by

Definition at line 220 of file term.cxx.

References clone().

Contract_Term CTF_int::Term::operator* ( int64_t  scl) const

multiples by a constant

Parameters
[in]sclscaling factor to multiply term by

Definition at line 274 of file term.cxx.

References CTF::Idx_Tensor::clone().

Contract_Term CTF_int::Term::operator* ( double  scl) const

Definition at line 280 of file term.cxx.

References CTF::Idx_Tensor::clone().

void CTF_int::Term::operator*= ( Term const &  B)

Definition at line 245 of file term.cxx.

void CTF_int::Term::operator*= ( double  scl)

Definition at line 250 of file term.cxx.

void CTF_int::Term::operator*= ( int64_t  scl)

Definition at line 255 of file term.cxx.

void CTF_int::Term::operator*= ( int  scl)

Definition at line 259 of file term.cxx.

Sum_Term CTF_int::Term::operator+ ( Term const &  A) const

constructs a new term by addition of two terms

Parameters
[in]Aterm to add to output

Definition at line 226 of file term.cxx.

References clone().

Sum_Term CTF_int::Term::operator+ ( double  scl) const
Sum_Term CTF_int::Term::operator+ ( int64_t  scl) const
void CTF_int::Term::operator+= ( Term const &  B)

Definition at line 243 of file term.cxx.

void CTF_int::Term::operator+= ( double  scl)

Definition at line 248 of file term.cxx.

void CTF_int::Term::operator+= ( int64_t  scl)

Definition at line 253 of file term.cxx.

void CTF_int::Term::operator+= ( int  scl)

Definition at line 257 of file term.cxx.

Sum_Term CTF_int::Term::operator- ( Term const &  A) const

constructs a new term by subtracting term A

Parameters
[in]Asubtracted term

Definition at line 232 of file term.cxx.

References CTF_int::alloc(), clone(), CTF_int::Sum_Term::operands, and scale.

Sum_Term CTF_int::Term::operator- ( double  scl) const
Sum_Term CTF_int::Term::operator- ( int64_t  scl) const
Term & CTF_int::Term::operator- ( )

Definition at line 263 of file term.cxx.

References ctf.core::scale().

void CTF_int::Term::operator-= ( Term const &  B)

Definition at line 244 of file term.cxx.

void CTF_int::Term::operator-= ( double  scl)

Definition at line 249 of file term.cxx.

void CTF_int::Term::operator-= ( int64_t  scl)

Definition at line 254 of file term.cxx.

void CTF_int::Term::operator-= ( int  scl)

Definition at line 258 of file term.cxx.

void CTF_int::Term::operator<< ( CTF_int::Term const &  B)

Definition at line 737 of file term.cxx.

References execute(), CTF_int::Contract_Term::execute(), CTF_int::Contract_Term::get_uniq_inds(), CTF_int::algstrct::mulid(), CTF_int::algstrct::safecopy(), scale, and sr.

void CTF_int::Term::operator<< ( double  scl)

Definition at line 741 of file term.cxx.

References CTF_int::Contract_Term::execute(), CTF_int::Contract_Term::get_uniq_inds(), and sr.

void CTF_int::Term::operator= ( CTF::Idx_Tensor const &  B)

A = B, compute any operations on operand B and set.

Parameters
[in]Btensor on the right hand side

Definition at line 241 of file term.cxx.

void CTF_int::Term::operator= ( Term const &  B)

Definition at line 242 of file term.cxx.

void CTF_int::Term::operator= ( double  scl)

Definition at line 247 of file term.cxx.

void CTF_int::Term::operator= ( int64_t  scl)

Definition at line 252 of file term.cxx.

void CTF_int::Term::operator= ( int  scl)

Definition at line 256 of file term.cxx.

virtual CTF::World* CTF_int::Term::where_am_i ( ) const
pure virtual

figures out what world this term lives on

Implemented in CTF_int::Contract_Term, CTF_int::Sum_Term, CTF::Idx_Tensor, CTF_int::Bifun_Term, and CTF_int::Unifun_Term.

Referenced by CTF_int::Unifun_Term::where_am_i(), and CTF_int::Bifun_Term::where_am_i().

Field Documentation

char* CTF_int::Term::scale

Definition at line 35 of file term.h.

Referenced by CTF_int::Bifun_Term::Bifun_Term(), CTF_int::contract_down_terms(), CTF_int::Contract_Term::Contract_Term(), CTF_int::Unifun_Term::estimate_time(), CTF_int::Bifun_Term::estimate_time(), CTF::Idx_Tensor::estimate_time(), CTF_int::Sum_Term::estimate_time(), CTF_int::Contract_Term::estimate_time(), CTF_int::Unifun_Term::execute(), CTF_int::Bifun_Term::execute(), CTF::Idx_Tensor::execute(), CTF_int::Sum_Term::execute(), CTF_int::Contract_Term::execute(), CTF::Idx_Tensor::Idx_Tensor(), CTF_int::endomorphism::operator()(), CTF::Idx_Tensor::operator+=(), operator-(), CTF_int::Sum_Term::operator-(), CTF::Idx_Tensor::operator-=(), operator<<(), CTF::Idx_Tensor::operator=(), CTF::Typ_Idx_Tensor< dtype_C >::operator=(), CTF_int::Sum_Term::Sum_Term(), and CTF_int::Unifun_Term::Unifun_Term().

algstrct* CTF_int::Term::sr

Definition at line 36 of file term.h.

Referenced by CTF_int::Bifun_Term::Bifun_Term(), CTF_int::Contract_Term::Contract_Term(), CTF_int::Bifun_Term::estimate_time(), CTF::Idx_Tensor::estimate_time(), CTF_int::Contract_Term::estimate_time(), CTF_int::Bifun_Term::execute(), CTF::Idx_Tensor::execute(), CTF_int::Sum_Term::execute(), CTF_int::Contract_Term::execute(), CTF::Idx_Tensor::Idx_Tensor(), CTF::Idx_Tensor::multeq(), CTF::Idx_Tensor::operator*=(), CTF::Idx_Tensor::operator+=(), CTF_int::Sum_Term::operator-(), CTF::Idx_Tensor::operator-=(), operator<<(), CTF::Idx_Tensor::operator=(), CTF::Typ_Idx_Tensor< dtype_C >::operator=(), CTF_int::Sum_Term::Sum_Term(), and CTF_int::Unifun_Term::Unifun_Term().

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