1Ops(3) User Contributed Perl Documentation Ops(3)
2
6 PDL::Ops - Fundamental mathematical operators
7
9 This module provides the functions used by PDL to overload the basic
10 mathematical operators ("+ - / *" etc.) and functions ("sin sqrt" etc.)
11 It also includes the function "log10", which should be a perl function
13 so that we can overload it!
14 Matrix multiplication (the operator "x") is handled by the module
16 PDL::Primitive.
17
19 none
20
22 plus
23 Signature: (a(); b(); [o]c(); int swap)
24 add two ndarrays
26 $c = $x + $y; # overloaded call
28 $c = plus $x, $y; # explicit call with default swap of 0
29 $c = plus $x, $y, 1; # explicit call with trailing 1 to swap args
30 $x->inplace->plus($y); # modify $x inplace
31 It can be made to work inplace with the "$x->inplace" syntax. This
33 function is used to overload the binary "+" operator. As of 2.065,
34 when calling this function explicitly you can omit the third argument
35 (see second example), or supply it (see third one).
36 plus processes bad values. The state of the bad-value flag of the
38 output ndarrays is unknown.
39 mult
41 Signature: (a(); b(); [o]c(); int swap)
42 multiply two ndarrays
44 $c = $x * $y; # overloaded call
46 $c = mult $x, $y; # explicit call with default swap of 0
47 $c = mult $x, $y, 1; # explicit call with trailing 1 to swap args
48 $x->inplace->mult($y); # modify $x inplace
49 It can be made to work inplace with the "$x->inplace" syntax. This
51 function is used to overload the binary "*" operator. As of 2.065,
52 when calling this function explicitly you can omit the third argument
53 (see second example), or supply it (see third one).
54 mult processes bad values. The state of the bad-value flag of the
56 output ndarrays is unknown.
57 minus
59 Signature: (a(); b(); [o]c(); int swap)
60 subtract two ndarrays
62 $c = $x - $y; # overloaded call
64 $c = minus $x, $y; # explicit call with default swap of 0
65 $c = minus $x, $y, 1; # explicit call with trailing 1 to swap args
66 $x->inplace->minus($y); # modify $x inplace
67 It can be made to work inplace with the "$x->inplace" syntax. This
69 function is used to overload the binary "-" operator. As of 2.065,
70 when calling this function explicitly you can omit the third argument
71 (see second example), or supply it (see third one).
72 minus processes bad values. The state of the bad-value flag of the
74 output ndarrays is unknown.
75 divide
77 Signature: (a(); b(); [o]c(); int swap)
78 divide two ndarrays
80 $c = $x / $y; # overloaded call
82 $c = divide $x, $y; # explicit call with default swap of 0
83 $c = divide $x, $y, 1; # explicit call with trailing 1 to swap args
84 $x->inplace->divide($y); # modify $x inplace
85 It can be made to work inplace with the "$x->inplace" syntax. This
87 function is used to overload the binary "/" operator. As of 2.065,
88 when calling this function explicitly you can omit the third argument
89 (see second example), or supply it (see third one).
90 divide processes bad values. The state of the bad-value flag of the
92 output ndarrays is unknown.
93 gt
95 Signature: (a(); b(); [o]c(); int swap)
96 the binary > (greater than) operation
98 $c = $x > $y; # overloaded call
100 $c = gt $x, $y; # explicit call with default swap of 0
101 $c = gt $x, $y, 1; # explicit call with trailing 1 to swap args
102 $x->inplace->gt($y); # modify $x inplace
103 It can be made to work inplace with the "$x->inplace" syntax. This
105 function is used to overload the binary ">" operator. As of 2.065,
106 when calling this function explicitly you can omit the third argument
107 (see second example), or supply it (see third one).
108 gt processes bad values. The state of the bad-value flag of the output
110 ndarrays is unknown.
111 lt
113 Signature: (a(); b(); [o]c(); int swap)
114 the binary < (less than) operation
116 $c = $x < $y; # overloaded call
118 $c = lt $x, $y; # explicit call with default swap of 0
119 $c = lt $x, $y, 1; # explicit call with trailing 1 to swap args
120 $x->inplace->lt($y); # modify $x inplace
121 It can be made to work inplace with the "$x->inplace" syntax. This
123 function is used to overload the binary "<" operator. As of 2.065,
124 when calling this function explicitly you can omit the third argument
125 (see second example), or supply it (see third one).
126 lt processes bad values. The state of the bad-value flag of the output
128 ndarrays is unknown.
129 le
131 Signature: (a(); b(); [o]c(); int swap)
132 the binary <= (less equal) operation
134 $c = $x <= $y; # overloaded call
136 $c = le $x, $y; # explicit call with default swap of 0
137 $c = le $x, $y, 1; # explicit call with trailing 1 to swap args
138 $x->inplace->le($y); # modify $x inplace
139 It can be made to work inplace with the "$x->inplace" syntax. This
141 function is used to overload the binary "<=" operator. As of 2.065,
142 when calling this function explicitly you can omit the third argument
143 (see second example), or supply it (see third one).
144 le processes bad values. The state of the bad-value flag of the output
146 ndarrays is unknown.
147 ge
149 Signature: (a(); b(); [o]c(); int swap)
150 the binary >= (greater equal) operation
152 $c = $x >= $y; # overloaded call
154 $c = ge $x, $y; # explicit call with default swap of 0
155 $c = ge $x, $y, 1; # explicit call with trailing 1 to swap args
156 $x->inplace->ge($y); # modify $x inplace
157 It can be made to work inplace with the "$x->inplace" syntax. This
159 function is used to overload the binary ">=" operator. As of 2.065,
160 when calling this function explicitly you can omit the third argument
161 (see second example), or supply it (see third one).
162 ge processes bad values. The state of the bad-value flag of the output
164 ndarrays is unknown.
165 eq
167 Signature: (a(); b(); [o]c(); int swap)
168 binary equal to operation ("==")
170 $c = $x == $y; # overloaded call
172 $c = eq $x, $y; # explicit call with default swap of 0
173 $c = eq $x, $y, 1; # explicit call with trailing 1 to swap args
174 $x->inplace->eq($y); # modify $x inplace
175 It can be made to work inplace with the "$x->inplace" syntax. This
177 function is used to overload the binary "==" operator. As of 2.065,
178 when calling this function explicitly you can omit the third argument
179 (see second example), or supply it (see third one).
180 eq processes bad values. The state of the bad-value flag of the output
182 ndarrays is unknown.
183 ne
185 Signature: (a(); b(); [o]c(); int swap)
186 binary not equal to operation ("!=")
188 $c = $x != $y; # overloaded call
190 $c = ne $x, $y; # explicit call with default swap of 0
191 $c = ne $x, $y, 1; # explicit call with trailing 1 to swap args
192 $x->inplace->ne($y); # modify $x inplace
193 It can be made to work inplace with the "$x->inplace" syntax. This
195 function is used to overload the binary "!=" operator. As of 2.065,
196 when calling this function explicitly you can omit the third argument
197 (see second example), or supply it (see third one).
198 ne processes bad values. The state of the bad-value flag of the output
200 ndarrays is unknown.
201 shiftleft
203 Signature: (a(); b(); [o]c(); int swap)
204 leftshift $a by $b
206 $c = $x << $y; # overloaded call
208 $c = shiftleft $x, $y; # explicit call with default swap of 0
209 $c = shiftleft $x, $y, 1; # explicit call with trailing 1 to swap args
210 $x->inplace->shiftleft($y); # modify $x inplace
211 It can be made to work inplace with the "$x->inplace" syntax. This
213 function is used to overload the binary "<<" operator. As of 2.065,
214 when calling this function explicitly you can omit the third argument
215 (see second example), or supply it (see third one).
216 shiftleft processes bad values. The state of the bad-value flag of the
218 output ndarrays is unknown.
219 shiftright
221 Signature: (a(); b(); [o]c(); int swap)
222 rightshift $a by $b
224 $c = $x >> $y; # overloaded call
226 $c = shiftright $x, $y; # explicit call with default swap of 0
227 $c = shiftright $x, $y, 1; # explicit call with trailing 1 to swap args
228 $x->inplace->shiftright($y); # modify $x inplace
229 It can be made to work inplace with the "$x->inplace" syntax. This
231 function is used to overload the binary ">>" operator. As of 2.065,
232 when calling this function explicitly you can omit the third argument
233 (see second example), or supply it (see third one).
234 shiftright processes bad values. The state of the bad-value flag of
236 the output ndarrays is unknown.
237 or2
239 Signature: (a(); b(); [o]c(); int swap)
240 binary or of two ndarrays
242 $c = $x | $y; # overloaded call
244 $c = or2 $x, $y; # explicit call with default swap of 0
245 $c = or2 $x, $y, 1; # explicit call with trailing 1 to swap args
246 $x->inplace->or2($y); # modify $x inplace
247 It can be made to work inplace with the "$x->inplace" syntax. This
249 function is used to overload the binary "|" operator. As of 2.065,
250 when calling this function explicitly you can omit the third argument
251 (see second example), or supply it (see third one).
252 or2 processes bad values. The state of the bad-value flag of the
254 output ndarrays is unknown.
255 and2
257 Signature: (a(); b(); [o]c(); int swap)
258 binary and of two ndarrays
260 $c = $x & $y; # overloaded call
262 $c = and2 $x, $y; # explicit call with default swap of 0
263 $c = and2 $x, $y, 1; # explicit call with trailing 1 to swap args
264 $x->inplace->and2($y); # modify $x inplace
265 It can be made to work inplace with the "$x->inplace" syntax. This
267 function is used to overload the binary "&" operator. As of 2.065,
268 when calling this function explicitly you can omit the third argument
269 (see second example), or supply it (see third one).
270 and2 processes bad values. The state of the bad-value flag of the
272 output ndarrays is unknown.
273 xor
275 Signature: (a(); b(); [o]c(); int swap)
276 binary exclusive or of two ndarrays
278 $c = $x ^ $y; # overloaded call
280 $c = xor $x, $y; # explicit call with default swap of 0
281 $c = xor $x, $y, 1; # explicit call with trailing 1 to swap args
282 $x->inplace->xor($y); # modify $x inplace
283 It can be made to work inplace with the "$x->inplace" syntax. This
285 function is used to overload the binary "^" operator. As of 2.065,
286 when calling this function explicitly you can omit the third argument
287 (see second example), or supply it (see third one).
288 xor processes bad values. The state of the bad-value flag of the
290 output ndarrays is unknown.
291 bitnot
293 Signature: (a(); [o]b())
294 unary bit negation
296 $y = ~ $x;
298 $x->inplace->bitnot; # modify $x inplace
299 It can be made to work inplace with the "$x->inplace" syntax. This
301 function is used to overload the unary "~" operator/function.
302 bitnot processes bad values. It will set the bad-value flag of all
304 output ndarrays if the flag is set for any of the input ndarrays.
305 power
307 Signature: (a(); b(); [o]c(); int swap)
308 raise ndarray $a to the power $b
310 $c = $x->power($y,0); # explicit function call
312 $c = $a ** $b; # overloaded use
313 $x->inplace->power($y,0); # modify $x inplace
314 It can be made to work inplace with the "$x->inplace" syntax. This
316 function is used to overload the binary "**" function. Note that when
317 calling this function explicitly you need to supply a third argument
318 that should generally be zero (see first example). This restriction is
319 expected to go away in future releases.
320 power processes bad values. The state of the bad-value flag of the
322 output ndarrays is unknown.
323 atan2
325 Signature: (a(); b(); [o]c(); int swap)
326 elementwise "atan2" of two ndarrays
328 $c = $x->atan2($y,0); # explicit function call
330 $c = atan2 $a, $b; # overloaded use
331 $x->inplace->atan2($y,0); # modify $x inplace
332 It can be made to work inplace with the "$x->inplace" syntax. This
334 function is used to overload the binary "atan2" function. Note that
335 when calling this function explicitly you need to supply a third
336 argument that should generally be zero (see first example). This
337 restriction is expected to go away in future releases.
338 atan2 processes bad values. The state of the bad-value flag of the
340 output ndarrays is unknown.
341 modulo
343 Signature: (a(); b(); [o]c(); int swap)
344 elementwise "modulo" operation
346 $c = $x->modulo($y,0); # explicit function call
348 $c = $a % $b; # overloaded use
349 $x->inplace->modulo($y,0); # modify $x inplace
350 It can be made to work inplace with the "$x->inplace" syntax. This
352 function is used to overload the binary "%" function. Note that when
353 calling this function explicitly you need to supply a third argument
354 that should generally be zero (see first example). This restriction is
355 expected to go away in future releases.
356 modulo processes bad values. The state of the bad-value flag of the
358 output ndarrays is unknown.
359 spaceship
361 Signature: (a(); b(); [o]c(); int swap)
362 elementwise "<=>" operation
364 $c = $x->spaceship($y,0); # explicit function call
366 $c = $a <=> $b; # overloaded use
367 $x->inplace->spaceship($y,0); # modify $x inplace
368 It can be made to work inplace with the "$x->inplace" syntax. This
370 function is used to overload the binary "<=>" function. Note that when
371 calling this function explicitly you need to supply a third argument
372 that should generally be zero (see first example). This restriction is
373 expected to go away in future releases.
374 spaceship processes bad values. The state of the bad-value flag of the
376 output ndarrays is unknown.
377 sqrt
379 Signature: (a(); [o]b())
380 elementwise square root
382 $y = sqrt $x;
384 $x->inplace->sqrt; # modify $x inplace
385 It can be made to work inplace with the "$x->inplace" syntax. This
387 function is used to overload the unary "sqrt" operator/function.
388 sqrt processes bad values. It will set the bad-value flag of all
390 output ndarrays if the flag is set for any of the input ndarrays.
391 sin
393 Signature: (a(); [o]b())
394 the sin function
396 $y = sin $x;
398 $x->inplace->sin; # modify $x inplace
399 It can be made to work inplace with the "$x->inplace" syntax. This
401 function is used to overload the unary "sin" operator/function.
402 sin processes bad values. It will set the bad-value flag of all output
404 ndarrays if the flag is set for any of the input ndarrays.
405 cos
407 Signature: (a(); [o]b())
408 the cos function
410 $y = cos $x;
412 $x->inplace->cos; # modify $x inplace
413 It can be made to work inplace with the "$x->inplace" syntax. This
415 function is used to overload the unary "cos" operator/function.
416 cos processes bad values. It will set the bad-value flag of all output
418 ndarrays if the flag is set for any of the input ndarrays.
419 not
421 Signature: (a(); [o]b())
422 the elementwise not operation
424 $y = ! $x;
426 $x->inplace->not; # modify $x inplace
427 It can be made to work inplace with the "$x->inplace" syntax. This
429 function is used to overload the unary "!" operator/function.
430 not processes bad values. It will set the bad-value flag of all output
432 ndarrays if the flag is set for any of the input ndarrays.
433 exp
435 Signature: (a(); [o]b())
436 the exponential function
438 $y = exp $x;
440 $x->inplace->exp; # modify $x inplace
441 It can be made to work inplace with the "$x->inplace" syntax. This
443 function is used to overload the unary "exp" operator/function.
444 exp processes bad values. It will set the bad-value flag of all output
446 ndarrays if the flag is set for any of the input ndarrays.
447 log
449 Signature: (a(); [o]b())
450 the natural logarithm
452 $y = log $x;
454 $x->inplace->log; # modify $x inplace
455 It can be made to work inplace with the "$x->inplace" syntax. This
457 function is used to overload the unary "log" operator/function.
458 log processes bad values. It will set the bad-value flag of all output
460 ndarrays if the flag is set for any of the input ndarrays.
461 re
463 Signature: (complexv(); real [o]b())
464 Returns the real part of a complex number.
466 re processes bad values. It will set the bad-value flag of all output
468 ndarrays if the flag is set for any of the input ndarrays.
469 im
471 Signature: (complexv(); real [o]b())
472 Returns the imaginary part of a complex number.
474 im processes bad values. It will set the bad-value flag of all output
476 ndarrays if the flag is set for any of the input ndarrays.
477 _cabs
479 Signature: (complexv(); real [o]b())
480 Returns the absolute (length) of a complex number.
482 _cabs processes bad values. It will set the bad-value flag of all
484 output ndarrays if the flag is set for any of the input ndarrays.
485 log10
487 Signature: (a(); [o]b())
488 the base 10 logarithm
490 $y = log10 $x;
492 $x->inplace->log10; # modify $x inplace
493 It can be made to work inplace with the "$x->inplace" syntax. This
495 function is used to overload the unary "log10" operator/function.
496 log10 processes bad values. It will set the bad-value flag of all
498 output ndarrays if the flag is set for any of the input ndarrays.
499 assgn
501 Signature: (a(); [o]b())
502 Plain numerical assignment. This is used to implement the ".=" operator
504 If "a" is a child ndarray (e.g., the result of a slice) and bad values
506 are generated in "b", the bad value flag is set in "b", but it is NOT
507 automatically propagated back to the parent of "a". The following
508 idiom ensures that the badflag is propagated back to the parent of "a":
509 $pdl->slice(":,(1)") .= PDL::Bad_aware_func();
511 $pdl->badflag(1);
512 $pdl->check_badflag();
513 This is unnecessary if $pdl->badflag is known to be 1 before the slice
515 is performed.
516 See http://pdl.perl.org/PDLdocs/BadValues.html#dataflow_of_the_badflag
518 for details.
519 carg
521 Signature: (complexv(); real [o]b())
522 Returns the polar angle of a complex number.
524 carg processes bad values. It will set the bad-value flag of all
526 output ndarrays if the flag is set for any of the input ndarrays.
527 conj
529 Signature: (complexv(); [o]b())
530 complex conjugate.
532 conj processes bad values. It will set the bad-value flag of all
534 output ndarrays if the flag is set for any of the input ndarrays.
535 czip
537 Signature: (r(); i(); complex [o]c())
538 convert real, imaginary to native complex, (sort of) like LISP zip
540 function. Will add the "r" ndarray to "i" times the "i" ndarray. Only
541 takes real ndarrays as input.
542 czip does not process bad values. It will set the bad-value flag of
544 all output ndarrays if the flag is set for any of the input ndarrays.
545 ipow
547 Signature: (a(); indx b(); [o] ans())
548 raise ndarray $a to integer power $b
550 $c = $x->ipow($y,0); # explicit function call
552 $c = ipow $x, $y;
553 $x->inplace->ipow($y,0); # modify $x inplace
554 It can be made to work inplace with the "$x->inplace" syntax. Note
556 that when calling this function explicitly you need to supply a third
557 argument that should generally be zero (see first example). This
558 restriction is expected to go away in future releases.
559 Algorithm from Wikipedia
561 <http://en.wikipedia.org/wiki/Exponentiation_by_squaring>
562 ipow does not process bad values. It will set the bad-value flag of
564 all output ndarrays if the flag is set for any of the input ndarrays.
565 abs
567 Returns the absolute value of a number.
568 abs2
570 Returns the square of the absolute value of a number.
571 r2C
573 Signature: (r(); complex [o]c())
574 convert real to native complex, with an imaginary part of zero
576 r2C does not process bad values. It will set the bad-value flag of all
578 output ndarrays if the flag is set for any of the input ndarrays.
579 i2C
581 Signature: (i(); complex [o]c())
582 convert imaginary to native complex, with a real part of zero
584 i2C does not process bad values. It will set the bad-value flag of all
586 output ndarrays if the flag is set for any of the input ndarrays.
587
589 Tuomas J. Lukka (lukka@fas.harvard.edu), Karl Glazebrook
590 (kgb@aaoepp.aao.gov.au), Doug Hunt (dhunt@ucar.edu), Christian Soeller
591 (c.soeller@auckland.ac.nz), Doug Burke (burke@ifa.hawaii.edu), and
592 Craig DeForest (deforest@boulder.swri.edu).
593perl v5.34.0 2022-02-28 Ops(3)