1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
<HTML><HEAD>
<TITLE>User's Reference - Compute</TITLE>
<META HTTP-EQUIV="keywords" CONTENT="GRAPHICS VISUALIZATION VISUAL PROGRAM DATA
MINING">
<meta http-equiv="content-type" content="text/html;charset=ISO-8859-1">
</HEAD><BODY BGCOLOR="#FFFFFF" link="#00004b" vlink="#4b004b">
<TABLE width=510 border=0 cellpadding=0 cellspacing=0>
<TR>
<TD><IMG src="../images/spacer.gif" width=80 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=49 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=24 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=100 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=3 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=127 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=6 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=50 height=1></TD>
<TD><IMG src="../images/spacer.gif" width=71 height=1></TD>
</TR>
<TR>
<TD colspan=9><IMG src="../images/flcgh_01.gif" width=510 height=24 alt="OpenDX - Documentation"></TD>
</TR>
<TR>
<TD colspan=2><A href="../allguide.htm"><IMG src="../images/flcgh_02.gif" width=129 height=25 border="0" alt="Full Contents"></A></TD>
<TD colspan=3><A href="../qikguide.htm"><IMG src="../images/flcgh_03.gif" width=127 height=25 border="0" alt="QuickStart Guide"></A></TD>
<TD><A href="../usrguide.htm"><IMG src="../images/flcgh_04.gif" width=127 height=25 border="0" alt="User's Guide"></A></TD>
<TD colspan=3><B><A href="../refguide.htm"><IMG src="../images/flcgh_05d.gif" width=127 height=25 border="0" alt="User's Reference"></A></B></TD>
</TR>
<TR>
<TD><A href="refgu035.htm"><IMG src="../images/flcgh_06.gif" width=80 height=17 border="0" alt="Previous Page"></A></TD>
<TD colspan=2><A href="refgu037.htm"><IMG src="../images/flcgh_07.gif" width=73 height=17 border="0" alt="Next Page"></A></TD>
<TD><A href="../refguide.htm"><IMG src="../images/flcgh_08.gif" width=100 height=17 border="0" alt="Table of Contents"></A></TD>
<TD colspan=3><A href="refgu009.htm"><IMG src="../images/flcgh_09.gif" width=136 height=17 border="0" alt="Partial Table of Contents"></A></TD>
<TD><A href="refgu175.htm"><IMG src="../images/flcgh_10.gif" width=50 height=17 border="0" alt="Index"></A></TD>
<TD><A href="../srchindx.htm"><IMG src="../images/flcgh_11.gif" width=71 height=17 border="0" alt="Search"></A></TD>
</TR>
</TABLE>
<H3><A name="HDRCOMPUTE" ></A>Compute</H3>
<A NAME="IDX428"></A><A NAME="IDX429"></A>
<P><STRONG>Category</STRONG>
<P>
<A HREF="refgu008.htm#HDRCATTRN">Transformation</A>
<A NAME="IDX430"></A>
<P><STRONG>Function</STRONG>
<P>
Evaluates an expression on each data point in a specified field or
value list.
<P><STRONG>Syntax</STRONG>
<PRE><STRONG>
output</STRONG> = Compute(<STRONG>expression, input, ...</STRONG>);
</PRE>
<P><STRONG>Inputs</STRONG>
<BR>
<TABLE BORDER>
<TR>
<TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Name
</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Type
</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Default
</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">Description
</TH></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>expression</STRONG></TT>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">string
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">none
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">expression to be computed
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>input</STRONG></TT>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">field or value list
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">no default
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">input value
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>...</STRONG></TT>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>...</STRONG></TT>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>...</STRONG></TT>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">more input values
</TD></TR></TABLE>
<P><STRONG>Outputs</STRONG>
<BR>
<TABLE BORDER>
<TR>
<TH ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">Name
</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">Type
</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="50%">Description
</TH></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="25%"><TT><STRONG>output</STRONG></TT>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">field, value, or value list
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%">output values
</TD></TR></TABLE>
<P><STRONG>Functional Details</STRONG>
<P>
This module applies an expression to every data value in a field.
<TABLE CELLPADDING="3">
<TR VALIGN="TOP"><TD><P><B><TT><STRONG>expression</STRONG></TT>
</B></TD><TD><P>is the mathematical expression to be applied to
<TT><STRONG>input</STRONG></TT>.
<A HREF="#TBLOPER">Table 1</A> lists the operators.
</TD></TR><TR VALIGN="TOP"><TD><P><B><TT><STRONG>input</STRONG></TT>
</B></TD><TD><P>is the field or value list to which
<TT><STRONG>expression</STRONG></TT>
is to be applied.
If there are more than one, the input fields must be isomorphic
(i.e., their hierarchies must match exactly).
</TD></TR></TABLE>
A single Compute module can operate on a maximum of 21
<TT><STRONG>input</STRONG></TT> values.
In the user interface, the default number of enabled input tabs is two.
The default number of enabled input tabs is two.
(Tabs can be added to the module icon and removed with the appropriate
<TT><STRONG>...Input Tab</STRONG></TT> options in the
<TT><STRONG>Edit</STRONG></TT> pull-down menu of
the VPE.)
<P>
In the user interface, variables have names and
<TT><STRONG>expression</STRONG></TT> does not
require quotation marks.
If the vector variable is "sample," the vector elements are
"sample.x," "sample.y," ... or "sample.0,"
"sample.1," ....
<P>
In the scripting language, the parameters of an expression are indicated
by $<I>n</I>, where <I>n</I> is the index of the parameter,
and counting begins at 0.
The first three components of a vector can be expressed
by "<I>.x</I>," "<I>.y</I>," and
"<I>.z</I>," or by "<I>.0</I>,"
"<I>.1</I>," and "<I>.2</I>."
The syntax for creating a vector from multiple inputs is
[<I>$0, $1, $2, ... </I> ], where the
commas separators are required.
<P>
Thus, in the user interface the expression used to add the value 3 to
every data value of the input field would be "a + 3.,"
while in the scripting language it would be "$0 + 3."
<P>
Multiple expressions can be entered if they are separated by
semicolons; the final expression is used as the output.
For example, "temp=a.x; sin(temp)" is equivalent to "sin(a.x)".
<P>
Compute uses C-language-style order of precedence for mathematical
operations.
<P>
Operations applied to invalid elements of fields typically
result in invalid elements. (For more information,
see <A HREF="usrgu025.htm#HDRINVAL">"Invalid Positions and Invalid Connections
Components"</A> in the <I>IBM Visualization Data Explorer User's Guide</I>.)
For example, if at a particular element field <I>"a"</I> and
<I>"c"</I> are valid, but field <I>"b"</I> is not,
<I>"a+b"</I> is invalid, and <I>"a? b: c"</I>
is valid only if <I>"a"</I> is 0;
otherwise, it is invalid.
An exception is the "invalid" function, which returns the integer
1 if the entry is invalid and 0 otherwise.
<P>
Operations such as multiplying a vector by a scalar have the expected
effect: each element of the vector is multiplied by the
scalar.
Likewise, the addition of two equal-length vectors or equal-size
matrices results in an element-by-element sum.
The Compute module defines the multiplication (<TT><STRONG>*</STRONG></TT>)
of two equal-length vectors as an element-by-element
multiplication (as opposed to the dot product).
Other operations, such as the sine of a vector, are defined similarly.
<P>
Constants may be specified as double precision by using scientific
notation with "d" indicating the exponent (e.g.,
<TT>1d0</TT> is double-precision <TT>1</TT>).
<P>
Note that you can convert a "ref" type invalid component (see
<A HREF="usrgu025.htm#HDRINVAL">"Invalid Positions and Invalid Connections
Components"</A> in <I>IBM Visualization Data Explorer User's Guide</I>)
using the expression "byte
(invalid (a))". Then use Replace to substitute this new array into
the original field as the "invalid positions" or "invalid
connections" component.
<P>
<BR>
<P><B><A NAME="TBLOPER" HREF="refgu002.htm#FT_TBLOPER">Table 1. Operators for
the Compute Module</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Functions
</B></TH><TH ALIGN="LEFT" VALIGN="TOP"><B>Types of Operands
</B></TH></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Trigonometric Functions (argument
in radians)
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> sin(a), cos(a),
tan(a), asin(a), acos(a), atan(a), atan2(a, b)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, double
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Hyperbolic Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> sinh(a), cosh(a),
tanh(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, double
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Logarithmic Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> log(a), In(a)
(natural logarithm), log10(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%">
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> (log base 10--see
Note 1), exp(a)
<P>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, double
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>IEEE inquiry functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> isnan(a), finite(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, double
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Unary Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> +a, -a
(negation)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> any type
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Binary Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> a+b, a-b,
a*b, a/b,
a%b (modulus--see Note 1),
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%">
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> a^b or a**b
(exponentiation--see Note 4)
<P>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> any type
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Vector Functions (see Note 1)
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> a dot b or dot(a, b)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float vector
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> a cross b or
cross(a,b)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float 3-vector
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> mag(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> double, float vector
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> norm(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float vector
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Miscellaneous Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> sqrt(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, double,
complex
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> pow(a, b) (see Note
4)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, double,
complex
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> abs(a) (see Note 2)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> double, float,
integer, complex
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> arg(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> complex only
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> sign(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> all real types
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> min(a, b, ...),
max(a, b, ...)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> scalar
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> invalid(a) (see Note
5)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> any type
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> random(a,seed) (see
note 8)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> produces random
values in the range
0<=r<1 for each item in a.
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Type Manipulation Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> int(a), float(a),
byte(a), char(a), double(a), short(a),
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, integer, byte,
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> sbyte, ubyte,
ushort, uint (see Note 6)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> short, double
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> trunc(a), floor(a),
ceil(a), rint(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, double
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> complex(a,b) or
complex(a),
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> float, integer, byte,
short,
double
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> real(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> complex only
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> imag(a)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> complex only
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Vector Construction
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> [a, b, ...]
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> any type
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Vector Selection Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> a.x or a.0, a.y or
a.1, and so on
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> vector
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> select(a,b) (selects
b<SUP>th</SUP> element of a,
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%">
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> where
element is of rank r-1)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> a is a vector, b is
an integer
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Conditional Functions
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> a?b:c
<BR>
if a != 0, then b, else c. (b and
c must be of the same type.) Expressions b and c
are always evaluated, and the output value depends on the value of a.
<P>
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> a is an integer
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Logical Operations
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> binary: <,
>, <=, >= (true = 1; false = 0)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> any scalar type
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> binary: ==, !=
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> any type
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> Unary: ! (not), binary: && (and), || (or) </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> integer
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>Bitwise Operations
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> and(a,b), xor(a,b),
or(a,b), not(a) (one's complement)
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> byte, int
<P>
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="2"><B>String functions (see Note 7)
</B></TD><TD ALIGN="LEFT" VALIGN="TOP"><B><BR></B></TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> strcmp(a,b)
<BR>
compares strings a and b and returns 0 if a==b, a negative integer if
a<b, and a positive integer if a>b
<BR>
stricmp is identical to strcmp except
that it ignores case
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> strings
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> strlen(a)
<BR>
returns the length of string a
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> string
</TD></TR><TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="4%">
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="69%"> strstr(a,b)
<BR>
finds substring b in string a and returns 1-based offset of b in a.
Thus strstr('artist','art') = 1 strstr('artist','picasso') = 0
strstr('monet','one') = 2
<BR>
stristr(a,b)
is identical to strstr except that it
ignores case
</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="27%"> strings
<P>
</TD></TR><TR>
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" COLSPAN="3"><B>Notes: </B>
<OL>
<P><LI>The vector functions, modulus function, and log10() function
do not accept complex numbers as arguments.
<P><LI>Given an integer or floating-point value, the abs() function
yields the absolute value. Given a complex number,
the abs() function yields a real absolute value.
<P><LI>If a string is passed as a parameter to Compute, it is
treated as an array of bytes, with its values being the ASCII
values of the string elements.
<P><LI>This function returns a floating-point value if inputs are floating
point or integer.
It returns a complex if the first input is complex.
<P><LI>Returns integer 1 if entity is marked invalid, and 0 otherwise.
<P><LI>Byte and char are same as ubyte.
<P><LI>Strings can be passed into Compute as the
data component or directly from String and StringList interactors.
Strings can also be specified in the Compute expression
directly by enclosing them in single quotes. A single
quote character is represented by a pair of single
quotes. Thus if a is the string "can't", then
strcmp(a,'can''t') = 0.
<P><LI>The random number generator will be seeded by the integer
<TT><STRONG>seed</STRONG></TT>. If <TT><STRONG>a</STRONG></TT> corresponds to a
group then each member of <TT><STRONG>a</STRONG></TT> will be seeded by
<TT><STRONG>seed</STRONG></TT>+n, where n corresponds to the member's
enumerated location in <TT><STRONG>a</STRONG></TT>. This results in repeatable
behavior even when a composite field is being processed in parallel on
an SMP machine. To generate different random results, use a different
<TT><STRONG>seed</STRONG></TT>.
</OL>
<P>
</TD></TR></TABLE>
To operate on a component other than "data," use the Mark and
Unmark modules together with Compute.
<P>
A single Compute module can operate on a maximum of 21
<TT><STRONG>...Input</STRONG></TT> values.
The default number of enabled input tabs is two.
(Tabs can be added to the module icon and removed with the appropriate
<TT><STRONG>...Input Tab</STRONG></TT> options in the
<TT><STRONG>Edit</STRONG></TT> pull-down menu
of the VPE.)
<TABLE><TR><TD ALIGN="LEFT" VALIGN="TOP"><B>Note:</B></TD><TD ALIGN="LEFT"
VALIGN="TOP">Other than a divide by zero, Compute operations are unchecked.
</td></tr></table>
<P><STRONG>Components</STRONG>
<P>
Modifies the "data" and "invalid positions" or
"invalid connections" components.
All other components are propagated to the output.
<P><STRONG>Script Language Examples</STRONG>
<OL>
<P><LI>The Compute module converts all the temperature data to Fahrenheit.
<PRE>
tempf = Compute("$0*(9.0/5.0) + 32", tempc);
·
</PRE>
<P><LI>The input field is a vector field of dimension 9.
The output field is scalar, consisting of the sixth component of the
input field.
<PRE>
new_field = Compute("$0.5",field);
</PRE>
<P><LI>The input field is a vector field, and the output field is also a
vector field, with the <I>x</I> component multiplied by 2.
<PRE>
new_field = Compute("[2*$0.x, $0.y, $0.z]", field);
</PRE>
<I>or</I>
<PRE>
new_field = Compute("[2, 1, 1]*$0", field);
</PRE>
<P><LI>Here <TT><STRONG>field1</STRONG></TT> is a vector field and
<TT><STRONG>field2</STRONG></TT> and <TT><STRONG>field3</STRONG></TT>
are scalar.
Therefore, the output field will have a data component equal
(on a point-by-point basis) to the magnitude of
<TT><STRONG>field1</STRONG></TT> added to the
quantity <TT><STRONG>field2</STRONG></TT>
divided by 4.5 times
<TT><STRONG>field3</STRONG></TT>.
<PRE>
new_field = Compute("mag($0) + $1/($2*4.5)", field1, field2, field3);
</PRE>
<P><LI>The Mark module to place the "positions" component of the
2-dimensional object <TT><STRONG>slice</STRONG></TT> in the "data"
component, allowing Compute to operate on the positions.
The formula string is assigned to <TT><STRONG>function</STRONG></TT> to
simplify the call to Compute and is equivalent to the following
formula for converting <TT><STRONG>slice</STRONG></TT> positions to 2-dimensional vectors: [ x, y, z ] = [ sin ( 2 π × ((x + 1) / 3.9) ) , y , - cos ( 2 π × ((x + 1) / 3.9) )]. When the computation is done, the Unmark module replaces the original "data" component for use in <TT><STRONG>warped</STRONG></TT>.
The resulting positions are warped onto the shape of a cylinder.
<PRE>
·
slice = Slice(electrondensity, "z", 5);
// Mark the positions so that they can be computed on
// The original x positions go from -1 to 2.9
// The original y positions go from -3 to 2.9
markedslice = Mark(slice,"positions");
// Warp the positions onto the shape of a cylinder
pi = 3.14159;
exp = "[sin(2*$1*($0.x+1)/3.9), $0.y, -cos(2*$1*($0.x+1)/3.9)]";
warped = Compute(exp, markedslice, pi);
// Unmark the warped positions, returning them to the positions
// component
warped = Unmark(warped, "positions");
·
</PRE>
<P><LI>This example differs from the previous one in that the
<TT><STRONG>exp</STRONG></TT>) function warps the positions onto a double cone shape, by implementing the following formula: [ x, y, z ] = [ y × sin( 2 π × ((x + 1) / 3.9) ) , y , -y × cos ( 2 π × ((x + 1) / 3.9) ) ]<PRE>
·
// Now warp the positions onto the shape of a doubled cone
// by multiplying the x and z positions by the original
// y value, which goes from -3 to 2.9
exp = "[$0.y*sin(2*$1*($0.x+1)/3.9),$0.y, -$0.y*cos(2*$1*($0.x+1)/3.9)]";
warped = Compute(exp, markedslice, pi);
// Unmark the warped positions, returning them to the positions
// component
warped = Unmark(warped, "positions");
·
</PRE>
</OL>
<P><STRONG>Example Visual Programs</STRONG>
<P>
Many of the example visual programs use Compute, including:
<PRE>
ComputeOnData.net
DataDrivenInteractors.net
PlotTwoLines.net
WarpingPositions.net
</PRE>
<P><STRONG>See Also</STRONG>
<P>
<A HREF="refgu093.htm#HDRMARK">Mark</A>,
<A HREF="refgu164.htm#HDRUNMARK">Unmark</A>
<P>
<HR>
<DIV align="center">
<P><A href="../allguide.htm"><IMG src="../images/foot-fc.gif" width="94" height="18" border="0" alt="Full Contents"></A> <A href="../qikguide.htm"><IMG src="../images/foot-qs.gif" width="94" height="18" border="0" alt="QuickStart Guide"></A> <A href="../usrguide.htm"><IMG src="../images/foot-ug.gif" width="94" height="18" border="0" alt="User's Guide"></A> <A href="../refguide.htm"><IMG src="../images/foot-ur.gif" width="94" height="18" border="0" alt="User's Reference"></A></P>
</DIV>
<DIV align="center">
<P><FONT size="-1">[ <A href="http://www.research.ibm.com/dx">OpenDX Home at IBM</A> | <A href="http://www.opendx.org/">OpenDX.org</A> ] </FONT></P>
<P></P>
</DIV>
<P></P>
</BODY></HTML>
|