Cyclops Tensor Framework
parallel arithmetic on multidimensional arrays
CTF_int::Bifun_Term Class Reference

#include <fun_term.h>

Inheritance diagram for CTF_int::Bifun_Term:
Collaboration diagram for CTF_int::Bifun_Term:

Public Member Functions

 Bifun_Term (Term *A, Term *B, bivar_function const *func)
 
 Bifun_Term (Bifun_Term const &other, std::map< tensor *, tensor * > *remap=NULL)
 
 ~Bifun_Term ()
 
Termclone (std::map< tensor *, tensor * > *remap=NULL) const
 base classes must implement this copy function to retrieve pointer More...
 
void execute (CTF::Idx_Tensor output) const
 evalues the expression, which just scales by default More...
 
CTF::Idx_Tensor execute (std::vector< char > out_inds) const
 evalues the expression to produce an intermediate with all expression indices remaining More...
 
CTF::Idx_Tensor estimate_time (double &cost, std::vector< char > out_inds) const
 estimates the cost the expression to produce an intermediate with all expression indices remaining More...
 
double estimate_time (CTF::Idx_Tensor output) const
 estimates the cost of a contraction/sum/.. term More...
 
std::vector< char > get_uniq_inds () const
 find list of unique indices that are involved in this term More...
 
void get_inputs (std::set< CTF::Idx_Tensor *, tensor_name_less > *inputs_set) const
 appends the tensors this depends on to the input set More...
 
CTF::Worldwhere_am_i () const
 figures out what world this term lives on More...
 
- Public Member Functions inherited from CTF_int::Term
 Term (algstrct const *sr)
 
virtual ~Term ()
 
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
 
Termoperator- ()
 
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)
 
 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

TermA
 
TermB
 
bivar_function const * func
 
- Data Fields inherited from CTF_int::Term
char * scale
 
algstrctsr
 

Detailed Description

Definition at line 42 of file fun_term.h.

Constructor & Destructor Documentation

CTF_int::Bifun_Term::Bifun_Term ( Term A,
Term B,
bivar_function const *  func 
)

Definition at line 70 of file fun_term.cxx.

References A, B, and func.

Referenced by clone().

CTF_int::Bifun_Term::Bifun_Term ( Bifun_Term const &  other,
std::map< tensor *, tensor * > *  remap = NULL 
)
CTF_int::Bifun_Term::~Bifun_Term ( )

Definition at line 78 of file fun_term.cxx.

References A, and B.

Member Function Documentation

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

base classes must implement this copy function to retrieve pointer

Implements CTF_int::Term.

Definition at line 83 of file fun_term.cxx.

References Bifun_Term().

CTF::Idx_Tensor CTF_int::Bifun_Term::estimate_time ( double &  cost,
std::vector< char >  out_inds 
) const
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

Implements CTF_int::Term.

Definition at line 123 of file fun_term.cxx.

double CTF_int::Bifun_Term::estimate_time ( CTF::Idx_Tensor  output) const
virtual

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

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

Implements CTF_int::Term.

Definition at line 128 of file fun_term.cxx.

References A, B, CTF_int::Term::estimate_time(), CTF_int::contraction::estimate_time(), func, CTF_int::Term::get_uniq_inds(), CTF::Idx_Tensor::idx_map, CTF_int::algstrct::mulid(), CTF::Idx_Tensor::parent, CTF_int::Term::scale, and CTF_int::Term::sr.

void CTF_int::Bifun_Term::execute ( CTF::Idx_Tensor  output) const
virtual

evalues the expression, which just scales by default

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

Implements CTF_int::Term.

Definition at line 96 of file fun_term.cxx.

References A, ASSERT, B, CTF_int::Term::execute(), CTF_int::contraction::execute(), func, CTF_int::Term::get_uniq_inds(), CTF::Idx_Tensor::idx_map, CTF_int::algstrct::isequal(), CTF_int::algstrct::mulid(), CTF::Idx_Tensor::parent, CTF::World::rank, CTF_int::Term::scale, CTF_int::Term::sr, and CTF_int::tensor::wrld.

Referenced by CTF_int::bivar_function::operator()().

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

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

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

Implements CTF_int::Term.

Definition at line 117 of file fun_term.cxx.

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

appends the tensors this depends on to the input set

Implements CTF_int::Term.

Definition at line 151 of file fun_term.cxx.

References A, B, and CTF_int::Term::get_inputs().

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

find list of unique indices that are involved in this term

Returns
out_inds unique indices to not contract/sum away

Implements CTF_int::Term.

Definition at line 137 of file fun_term.cxx.

References A, B, and CTF_int::Term::get_uniq_inds().

CTF::World * CTF_int::Bifun_Term::where_am_i ( ) const
virtual

figures out what world this term lives on

Implements CTF_int::Term.

Definition at line 156 of file fun_term.cxx.

References A, B, and CTF_int::Term::where_am_i().

Field Documentation

Term* CTF_int::Bifun_Term::A
Term* CTF_int::Bifun_Term::B
bivar_function const* CTF_int::Bifun_Term::func

Definition at line 46 of file fun_term.h.

Referenced by Bifun_Term(), estimate_time(), and execute().


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