In file Math.hh:

namespace events class Math : public Function

Event columns can be used in math expression which can be used everywhere an event function is needed

Inheritance:


Public Classes

enum operation
Math operations.
opPos
Positive value
opNeg
Negative value
opInc
Increment (prefix)
opDec
Decrement (prefix)
opAdd
Addition
opSub
Subtraction
opMul
Multiplication
opDiv
Division
opMod
Modulus
opAbs
Absolute value
opSqrt
Square root
opPow
Power
opExp
Exponential
opLog
Natural logarithm
opLog10
Logarithm base 10
opSin
Sine
opCos
Cosine
opTan
Tangent
opAsin
Arc sine
opAcos
Arc cosine
opAtan
Arc tangent
opAtan2
Arc tangent (2 arguments)
opSinh
Sine hyp
opCosh
Cosine hyp
opTanh
Tangent hyp
opCeil
Ceiling
opFloor
Floor
opNot
Negate ~
opAnd
And &
opOr
Or |
opXor
Xor ^
opLeft
Left shift <<
opRight
Right shift >>
opConj
Complex conjugate
opPolar
Complex number in polar notation
opReal
Real part
opImag
Imaginary part
opArg
Argument
opNorm
Norm

Public Methods

Math (const Function& f, operation op)
Constructor
Math (const Function& f1, const Function& f2, operation op)
Constructor
virtual Math* Copy () const
Copy the event column
virtual bool Evaluate (const Argument& arg, Value& val) const
Math expression value

Protected Methods

Math ()
Default constructor

Inherited from Function:

Public Methods

bool operator) (const Argument& arg, Value& val) const
bool operator) (const Event& event, Value& val) const

Protected Methods

Function& operator= (const Function&)

Documentation

Event columns can be used in math expression which can be used everywhere an event function is needed. For example one can write
    5 < sqrt (pwr (Column ("Amplitude(0)"), 2) +
              pwr (Column ("Amplitude(1)"), 2) )
    \begin{verbatim}
    to define an event condition which checks whether the vector 
    sum of the amplitudes of two events is larger than 5.
   
    @memo Defines the event math routines
    @author Written June 2001 by Masahiro Ito and Daniel Sigg
    @version 1.0

enum operation
Math operations supported by the function.

opPos
Positive value

opNeg
Negative value

opInc
Increment (prefix)

opDec
Decrement (prefix)

opAdd
Addition

opSub
Subtraction

opMul
Multiplication

opDiv
Division

opMod
Modulus

opAbs
Absolute value

opSqrt
Square root

opPow
Power

opExp
Exponential

opLog
Natural logarithm

opLog10
Logarithm base 10

opSin
Sine

opCos
Cosine

opTan
Tangent

opAsin
Arc sine

opAcos
Arc cosine

opAtan
Arc tangent

opAtan2
Arc tangent (2 arguments)

opSinh
Sine hyp

opCosh
Cosine hyp

opTanh
Tangent hyp

opCeil
Ceiling

opFloor
Floor

opNot
Negate ~

opAnd
And &

opOr
Or |

opXor
Xor ^

opLeft
Left shift <<

opRight
Right shift >>

opConj
Complex conjugate

opPolar
Complex number in polar notation

opReal
Real part

opImag
Imaginary part

opArg
Argument

opNorm
Norm

Math(const Function& f, operation op)
Creates an math expression of a single value (unary operator).

Math(const Function& f1, const Function& f2, operation op)
Creates an math expression of two values (binary operator).

virtual Math* Copy() const
Returns a copy of the event column math object. This method must be overriden by all descendents.
Returns:
event copy

virtual bool Evaluate(const Argument& arg, Value& val) const
Returns the evaluated math expression.
Returns:
true if successful
Parameters:
arg - Event argument list
val - Fucntion value (return)

Math()
Default constructor


This class has no child classes.

alphabetic index hierarchy of classes


Please send questions and comments to sigg_d@ligo-wa.caltech.edu


generated by doc++