Copyright (C) 2000-2012 |
Manpages OpsSection: User Contributed Perl Documentation (3)Updated: 2002-04-08 Index Return to Main Contents NAMEPDL::Ops - Fundamental mathematical operatorsDESCRIPTIONThis module provides the functions used by PDL to overload the basic mathematical operators ("+ - / *" etc.) and functions ("sin sqrt" etc.)It also includes the function "log10", which should be a perl function so that we can overload it! SYNOPSISnoneFUNCTIONSplusSignature: (a(); b(); [o]c(); int swap)add two piddles
$c = plus $a, $b, 0; # explicit call with trailing 0 $c = $a + $b; # overloaded call $a->inplace->plus($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "+" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. multSignature: (a(); b(); [o]c(); int swap)multiply two piddles
$c = mult $a, $b, 0; # explicit call with trailing 0 $c = $a * $b; # overloaded call $a->inplace->mult($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "*" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. minusSignature: (a(); b(); [o]c(); int swap)subtract two piddles
$c = minus $a, $b, 0; # explicit call with trailing 0 $c = $a - $b; # overloaded call $a->inplace->minus($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "-" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. divideSignature: (a(); b(); [o]c(); int swap)divide two piddles
$c = divide $a, $b, 0; # explicit call with trailing 0 $c = $a / $b; # overloaded call $a->inplace->divide($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "/" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. gtSignature: (a(); b(); [o]c(); int swap)the binary > (greater than) operation
$c = gt $a, $b, 0; # explicit call with trailing 0 $c = $a > $b; # overloaded call $a->inplace->gt($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary ">" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. ltSignature: (a(); b(); [o]c(); int swap)the binary < (less than) operation
$c = lt $a, $b, 0; # explicit call with trailing 0 $c = $a < $b; # overloaded call $a->inplace->lt($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "<" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. leSignature: (a(); b(); [o]c(); int swap)the binary <= (less equal) operation
$c = le $a, $b, 0; # explicit call with trailing 0 $c = $a <= $b; # overloaded call $a->inplace->le($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "<=" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. geSignature: (a(); b(); [o]c(); int swap)the binary >= (greater equal) operation
$c = ge $a, $b, 0; # explicit call with trailing 0 $c = $a >= $b; # overloaded call $a->inplace->ge($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary ">=" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. eqSignature: (a(); b(); [o]c(); int swap)binary equal to operation ("==")
$c = eq $a, $b, 0; # explicit call with trailing 0 $c = $a == $b; # overloaded call $a->inplace->eq($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "==" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. neSignature: (a(); b(); [o]c(); int swap)binary not equal to operation ("!=")
$c = ne $a, $b, 0; # explicit call with trailing 0 $c = $a != $b; # overloaded call $a->inplace->ne($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "!=" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. shiftleftSignature: (a(); b(); [o]c(); int swap)leftshift "a$" by $b
$c = shiftleft $a, $b, 0; # explicit call with trailing 0 $c = $a << $b; # overloaded call $a->inplace->shiftleft($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "<<" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. shiftrightSignature: (a(); b(); [o]c(); int swap)leftshift "a$" by $b
$c = shiftright $a, $b, 0; # explicit call with trailing 0 $c = $a >> $b; # overloaded call $a->inplace->shiftright($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary ">>" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. or2Signature: (a(); b(); [o]c(); int swap)binary or of two piddles
$c = or2 $a, $b, 0; # explicit call with trailing 0 $c = $a | $b; # overloaded call $a->inplace->or2($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "|" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. and2Signature: (a(); b(); [o]c(); int swap)binary and of two piddles
$c = and2 $a, $b, 0; # explicit call with trailing 0 $c = $a & $b; # overloaded call $a->inplace->and2($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "&" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. xorSignature: (a(); b(); [o]c(); int swap)binary exclusive or of two piddles
$c = xor $a, $b, 0; # explicit call with trailing 0 $c = $a ^ $b; # overloaded call $a->inplace->xor($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "^" operator. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. bitnotSignature: (a(); [o]b())unary bit negation
$b = ~ $a; $a->inplace->bitnot; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "~" operator/function. powerSignature: (a(); b(); [o]c(); int swap)raise piddle $a to the power "b"
$c = $a->power($b,0); # explicit function call $c = $a ** $b; # overloaded use $a->inplace->power($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "**" function. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. atan2Signature: (a(); b(); [o]c(); int swap)elementwise "atan2" of two piddles
$c = $a->atan2($b,0); # explicit function call $c = atan2 $a, $b; # overloaded use $a->inplace->atan2($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "atan2" function. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. moduloSignature: (a(); b(); [o]c(); int swap)elementwise "modulo" operation
$c = $a->modulo($b,0); # explicit function call $c = $a % $b; # overloaded use $a->inplace->modulo($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "%" function. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. spaceshipSignature: (a(); b(); [o]c(); int swap)elementwise "~" operation
$c = $a->spaceship($b,0); # explicit function call $c = $a <=> $b; # overloaded use $a->inplace->spaceship($b,0); # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the binary "<=>" function. Note that when calling this function explicitly you need to supply a third argument that should generally be zero (see first example). This restriction is expected to go away in future releases. sqrtSignature: (a(); [o]b())elementwise square root
$b = sqrt $a; $a->inplace->sqrt; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "sqrt" operator/function. absSignature: (a(); [o]b())elementwise absolute value
$b = abs $a; $a->inplace->abs; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "abs" operator/function. sinSignature: (a(); [o]b())the sin function
$b = sin $a; $a->inplace->sin; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "sin" operator/function. cosSignature: (a(); [o]b())the cos function
$b = cos $a; $a->inplace->cos; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "cos" operator/function. notSignature: (a(); [o]b())the elementwise not operation
$b = ! $a; $a->inplace->not; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "!" operator/function. expSignature: (a(); [o]b())the exponential function
$b = exp $a; $a->inplace->exp; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "exp" operator/function. logSignature: (a(); [o]b())the natural logarithm
$b = log $a; $a->inplace->log; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "log" operator/function. log10Signature: (a(); [o]b())the base 10 logarithm
$b = log10 $a; $a->inplace->log10; # modify $a inplaceIt can be made to work inplace with the "$a->inplace" syntax. This function is used to overload the unary "log10" operator/function. assgnSignature: (a(); [o]b())Plain numerical assignment. This is used to implement the ``.='' operator AUTHORTuomas J. Lukka (lukka@fas.harvard.edu), Karl Glazebrook (kgb@aaoepp.aao.gov.au), Doug Hunt (dhunt@ucar.edu), Christian Soeller (c.soeller@auckland.ac.nz), and Doug Burke (burke@ifa.hawaii.edu).
Index
This document was created by man2html, using the manual pages. Time: 00:19:45 GMT, March 29, 2024 |