Alphabetical List of Primitives, Operators, and Units
Primitives
Absolute value (magnitude for complex numbers) - acos
Arc cosine - activenode
Name of the node currently executing - alert
Displays a message - all
List of all node names - append
Appends to a text file - appendcsv
Appends to a comma-delimited data file - appendtxt
Appends to a tab-delimited data file - appname
Displays the program name in a dialog or screen - arg
The argument or angle of a complex number - argdef
Retrieves the definition of a functional argument - arguments
List of all argument values in the active function - argval
Value of a specific argument in the active function - Array
Array object constructor - asc
ASCII code of a character - asin
Arc sine - askmultitext
Asks the user to enter a multiline text string - asknumber
Asks the user to enter a number - asktext
Asks the user to enter a text string - askyesno
Asks the user a Yes/No question - Assumption
Shortcut notation to access the functionality of the Assumptions object; they are functionally identical, but Assumption uses the root definition
See Assumptions.
Note: This primitive can only be used in Report Writer.
See Create Custom Interfaces with Report Writer. - atan
2-quadrant arc tangent - atan2
4-quadrant arc tangent - authorid
Returns the Author ID of the specified model file - avg
Average of all numbers in a list - beep
Produces an audible tone - best
Value and name of the greatest element in a list - betarand
Pseudo-random number from a beta distribution - bin
Sorts data into groups and counts the number of items in each group - Boolean
Boolean object constructor - both
Applies a function to groups of corresponding elements in two lists - branch
Creates a decision tree branch node - branchoptions
List of child nodes to the active branch node - brand
Pseudo-random number from a binomial distribution - break
Terminates a for or while loop - buffer_append
Appends text to a named data storage buffer - buffer_read
Reads the contents of a named data storage buffer - buffer_write
Writes text to a named data storage buffer - case
Keyword - identifies a case in a switch statement - ceil
Integer value of a number rounded up - cf
term/rate/pv/pmt/fv cash flow calculations - children
List of all nodes called directly by a node - choose
Asks the user to choose an item from a list - chr
Character value of an ASCII code - clear
Sets the value of a node to null - close
Closes the active document - cnorm
Cumulative normal distribution - comment
Comment text attached to a node - compare
Compares two lists - component
Loads a library component - componentdir
File directory where the component resides - consolidate
Combines library component objects into a single consolidated object - continue
Skips part of a for or while loop - copyfile
Copies a disk file - copyproperties
Copies all properties in the source object to the destination object - correlate
Causes random inputs to be correlated - correlatenext
Purges cached data in a correlated Monte Carlo process - correlation
Correlation coefficient for a pair of data sets - cos
Cosine - count
Number of elements in a list - crand
Pseudo-random number from a custom distribution - crc32
Returns the 32-bit CRC value for the given text - createdirectory
Creates a file directory or folder - createhtmltable
HTML table presentation of matrix data - da
Days, time unit of measure - Date
Date object constructor - date
Text presentation of a date derived from a date-time serial number - datenum
Serial number of a specific date and time - datetime
Text presentation of a date and time derived from a serial number - day
Day of the month derived from a date-time serial number - dbcreate
Creates a database file - dbdelete
Deletes a database file record - dbdir
Deletes a database file record - dbpack
Removes the unused space from a database file - dbread
Returns a list of database records - dbwrite
Creates a database file and record and writes data to the record - dde
Raw Dynamic Data Exchange link - ddelink
Evaluated Dynamic Data Exchange link - default
Keyword - identifies the default case in a switch statement - deg
Degree, angle unit of measure - deletefile
Deletes a disk file - derivative
Partial derivative of a function - determinant
Determinant of a matrix - dialog
Creates a custom dialog box or HTML form for user input/output - dialogbuttons
Numeric code indicating which dialog() buttons are displayed - dialogparam
Global object that provides the default values for dialogs and forms - dialogroot
Adds Back buttons to dialog input forms - dialogtemplate
HTML form text attached to a node - different
All elements unique to any one of several input lists - dim
Dimensioned variable array - dir
List of files matching a specification - Discount Rate
Reserved node name used by the pvx primitive - do/while
Keyword - defines a do()..while() loop - docname
Full path and filename of the active model or script - document
The main document object used to control models programmatically - dolist
Keyword - applies a function to parallel lists of input data - dolist and domatrix
Applies a function to lists of input data - domatrix
Keyword - applies a function to independent lists of input data - drand
Pseudo-random number from a discrete distribution - dt
Period length in a time-based model - dtype
Data type identifier (number, text, etc.) - E
2.71828 - each
Applies a function to each element in a list - eachn
Applies a function to each element in a list with incrementing index - elapsedtime
Amount of time the current model has been open - emv
Expected monetary value - endnodes
Name of all end nodes in a tree or branch - env
Gets HTML request header data from the Web server - err
Sets the error flag and terminates calculation - escape
Replaces reserved characters in text strings with %nn codes - eval
Compiles and evaluates a text string - ExecInitLog
Clears the contents of the session history (ExecLog) - ExecLog
Session history - ExecQuery
Get parameter values passed to the script - ExecWriteLog
Appends new text to the session history (ExecLog) - exists
Tests for the existence of a node - exit
Closes all documents and terminates the main application - exp
Exponential (E^x) - expandbranch
Creates a child node for the node in which it is used - false
Logical false - fft
Fast Fourier Transform - file_close
Closes a file opened by file_open or file_create - file_create
Creates and opens a new file - file_open
Opens an existing file - file_read
Reads data from a file - file_write
Writes data to a file - filedate
Returns the Last Modified Date of the file - filesize
Returns the size of the file, in bytes - find
Position of a substring in a string - findlast
Position of the last occurrence of a substring in a string - firsttrue
Name of the first argument in a list that evaluates true - flatten
Creates a flat list from a matrix or list of lists - floor
Integer value of a number rounded down - flush
Displays the contents of the output buffer - for
For...next loop - form
Creates an output form from a list of values - Function
Function object constructor - function
Keyword - defines a function - fv
Future value of an annuity - gamma
Gamma function - gammaln
Log of the Gamma function - gate
Stops calculation when Logical Look-Ahead is active - getclipboard
Contents of the Windows text clipboard - getfile
Prompts for a filename using a GUI screen - getlasterror
Retrieves the last error message in the script - getnode
Prompts for a node name using a GUI screen - getselect
Prompts the user to select one or more items from a list - grand
Pseudo-random number from a gamma distribution - graph
Creates a Graph sheet containing a line, bar, or scatter plot - graph3
Creates a Surface Plot sheet containing a 3-D graph - group
Matrix created by grouping elements in a list - half
Half of a year, time unit of measure - hasunits
Returns true if a value has units of measure - hostipaddress
IP address of the computer executing a script - hour
Hour derived from a date-time serial number - hr
Hours, time unit of measure - htmldecode
Replaces HTML codes &, <, >, " with characters - htmlencode
Replaces characters &, <, >, and " with HTML codes - HTMLpostfix
If a model has a node named HTMLpostfix, it is used to filter all HTML immediately before it is sent to a Web user by the dialog primitive. HTMLpostfix lets you alter the HTML. - I
Unit imaginary number - IF or if
Function form of if...then...else conditional - imag
The imaginary portion of a complex number - include
Imports library functions into the active application - index
The position of a particular element or sublist in a list - infinity
Infinity - Inflation Rate
Reserved node name used by the pvx primitive - inputs
List of all nodes declared as inputs - inputunits
Returns the unit of measurement for the specified node - insertdatasheet
Create a new Data Table sheet - insertdiagramsheet
Create a new Diagram sheet - insertgraph
Create a new Graph sheet - insertgraph3
Create a new Surface Plot sheet - insertreportsheet
Create a new Report sheet - inserttable
Create a new Presentation Table sheet - inserttextsheet
Create a new Text Sheet - inserttreesheet
Create a new Tree Sheet - integer
Integer value rounded towards zero - integral
Definite integral of a function - intersect
All elements common to every input list - invfft
Inverse Fast Fourier Transform - irr
Internal rate of return - isinreplay
Returns true if a script is replaying steps in response to clicking Back - isNaN
Returns true if a data type is NaN - isweb
Returns true if the model is running as a Web application - last
Last element in a list - len
Number of characters in a string - length
Length of a list, characters in a string, or arguments in a function - linefit
Coefficients of a general linear regression - log
Natural logarithm (base E) - log10
Common logarithm (base 10) - Loop Primitives
A loop statement can replace an entire funtion - lower
String with all characters converted to lowercase - lrand
Pseudo-random number from a lognormal distribution - mail
Sends an Internet e-mail message - makelist
List of f(n) over a range of n - mask
Prevents calculation errors from terminating execution - maskall
Prevents all errors from terminating execution - maskcancel
Prevents the Cancel button from terminating execution - Math
Math object - max
Highest element in a list - med
Median element in a list - method
Creates a method pointer - min
Lowest element in a list - minimize
Minimum of a function of one variable - minute
Minute derived from a date-time serial number - Mixed
Wrap Mixed around a function definition to prevent the report from summing the values of the nodes within it
Note: This primitive can only be used in Report Writer.
See Create Custom Interfaces with Report Writer. - mkv
Defines a branch in a Markov model - model
Executes a command in the Model namespace - month
Month derived from a date-time serial number - movefile
Moves a disk file - mxsimplex
Linear program optimization based on matrix input data - namespace
Execute a command in the specified namespace - no
Logical false - noriskaversion
Turns off risk aversion settings while executing a set of commands - nounits
Evaluates an expression without unit processing - now
Serial number of the current date and time - npv
Net present value - nrand
Pseudo-random number from a normal distribution - null
Empty list - Number
Number object constructor - Object
General object constructor - OnEnd
Node executed just before a model, component, or DLM ends - OnLoad
Node executed when a model, component, or DLM is loaded - OnStart
Node executed when a model, component, or DLM is started - open
Opens a new document file - Optional Return
Optional return of the value of the last expression in the definition's statement block - options
Causes component input values to display as a drop-down list - outputs
List of all nodes declared as outputs - parse
Parses a node definition into a list of arguments - parseFloat
Floating point number derived from a text string - parsehtmltable
Parses an HTML table into matrix data - parseInt
Integer derived from a text string - partslist
Builds a single consolidated object from a parts list of components - pct
Element at a specific percentile position in a list after sorting - PI
3.14159 - pmt
Payment for an installment loan - prand
Pseudo-random number from a Poisson distribution - precision
Sets the precision for approximated functions - primitive
Executes a command in the Primitive namespace - print
Appends text to the output buffer - prod
Product of all numbers in a list - programdir
File directory where the program resides - propname
Name of the currently executing method or property - pv
Present value of an annuity - pvx
Present value of a cash stream - rand
Pseudo-random number from a uniform distribution - rankcorrelation
Measures the correspondence between the two rankings - rate
Interest rate of investment - read
Loads the contents of a text file - readbin
Loads the contents of a binary data file - readcookie
Reads a persistent cookie from the user's Web browser - readcsv
Loads the contents of a comma-delimited data file - readhttp
Reads a document from the Internet via the HTTP protocol - readobj
Loads the contents of a binary data file - readsimplex
Imports comma-delimited data and performs a linear optimization - readtxt
Loads the contents of a tab-delimited data file - readuserfile
Prompts a Web user for the name of a file and uploads its contents - real
The real portion of a complex number - redirect
Transfers the user to a Web page outside the active script - reduceunits
Number without units as it would display in the current unit system - redunits
Identifies a constant as a reduction unit - remove
Removes a node from memory - removedirectory
Deletes a file directory or folder - rename
Renames a node - repeat
String created by repeating a substring a given number of times - replace
Replaces a specific occurrence of a substring - replist
Replaces a specific occurrence of a sublist - replybin
Sends data to the requesting host - reset
Marks all constants as unevaluated - Resource Tree
Node executed to load the resource tree for a model - return
Returns the specified value from a function call - reverse
Reverses the order of all elements in a list - RGB
Build a RGB color value - Rollup
Uses the current node name to show the sum of that record for each entity defined in the system
Note: This primitive can only be used in Report Writer.
See Create Custom Interfaces with Report Writer. - RollupWhere
Dynamically builds a collapsible tree structure based on the attributes applied to records matching the filter you apply
Note: This primitive can only be used in Report Writer.
See Create Custom Interfaces with Report Writer. - root
Root, or zero, of a function - rootnode
Name of the root node in the active tree - round
Rounds a number to a given number of decimals - rsquared
R-squared measure of fit for a regression line - safeexp
Exponential (E^x), with a trap to prevent overflow - save
Saves the current document to a file - say
Displays a message - scriptdir
File directory where the executing script resides - second
Second derived from a date-time serial number - selecteditem
Extracts the selected drop-down menu item from a dialog result list - selectednode
Name of the selected tree node(s) - selrand
Sets probability of list items and selects an item - sessionid
Unique ID assigned to the session by the Web server - setauthentication
Sends user authentication information to the Vanguard server - setcormat
Sets the correlation matrix to use in a Monte Carlo simulation - setinterval
Sets an interrupt that is called periodically during long calculations - setlanguage
Selects an existing language for local comments and form fields - setrand
Seeds the random number generators - settimebase
Sets the period zero and the period length for time-based projections - show
Definition or formula used to create a node - showlog
Contents of the session log buffer in HTML format - sigma
Summation of a function between specified limits - simplex
Linear optimization of a function of many variables - simplex2
Linear optimization of a function of many variables - sin
Sine - sleep
Pauses execution for a specific amount of time - socket_accept
Waits for a TCP/IP socket connection from a remote client - socket_close
Closes a TCP/IP socket connection - socket_connect
Connects to a remote TCP/IP server - socket_receive
Receives data on a TCP/IP socket connection - socket_send
Sends data on a TCP/IP socket connection - solve
Solution to a set of simultaneous linear equations - sort
List sorted from lowest to highest value - sql
Performs a SQL query via ODBC with standard DSN data - sqlgetsource
Prompts a local user for an ODBC data source - sqlquery
Performs a SQL query via ODBC with extended DSN data - sqrt
Square root - status
Displays a message on the Status Bar - std
Standard deviation of all numbers in a list - stderror
Standard error for each coefficient in a regression analysis - String
String object constructor - striphtml
Text string with all HTML codes removed - stripunits
Number with all units of measure removed - sublist
Segment of a list - substitute
Replaces all occurrences of a substring - substring
Segment of a text string - sum
Sum of all numbers in a list - switch
Keyword - defines a switch statement - t
Current execution time in a time-based model - t0
Date and time serial number corresponding to the Period zero date. - table
Creates a Table sheet - tableform
Table representation of a matrix - tan
Tangent - term
Term of investment - this
Pointer to the currently executing object - time
Text presentation of a time derived from a date-time serial number - todate
Serial number of a specific date and time from a text string - tolist
List created by parsing a string into substrings - toliteral
Converts expressions into literals (source code) - tonumber
Number derived from a text string - topsheet
Name of the displayed sheet - tostring
Converts a list or number to text - trand
Pseudo-random number from a triangular distribution - trans
Transpose of a matrix - treelist
List of all nodes called directly and indirectly by a node - true
Logical true - tx
Date and time serial number equivalent of the period index t - unescape
Replaces %nn codes in text strings with corresponding characters - union
All elements in all input lists without duplicates - unit
Executes a command in the Unit namespace - units
Sets preferred units for a Web application's input - unitsof
Units of measure applied to a value - upper
String with all characters converted to uppercase - user
Executes a command in the User namespace - ustointl
Converts US string formatting to local system formatting - variance
Variance of all numbers in a list - version
This program's version number - waitforrequest
Pauses the system until a request message has been received - watch
Displays intermediate values to help debug applications at runtime - weekday
Day of the week derived from a date-time serial number - while
While loop - winexec
Executes a Windows program - wordwrap
Inserts carriage returns in a text string to wrap text - wrand
Pseudo-random number from a Weibull distribution - write
Writes to a text file - writebin
Writes to a binary data file - writecookie
Writes data to the user's Web browser as a persistent cookie - writecookienext
Writes a cookie to the user's browser when the next page is displayed - writecsv
Writes to a comma-delimited data file - writelog
Appends text to the session history buffer - writeobj
Writes to a binary data file - writetxt
Writes to a tab-delimited data file - year
Year derived from a date-time serial number - yes
Logical true
Operators
Operator x->y adds a value to the global accumulator - Add
Operator x+y numeric or matrix addition - Assign
Operator x=y sets variable x equal to the value y - Bitwise And
Operator x&y AND of all bits in x and y - Bitwise Exclusive Or
Operator x~y Exclusive OR of all bits in x and y - Bitwise Not
Operator ~x inverts all bits in x - Bitwise Or
Operator x|y OR of all bits in x and y - Compound Assignment
Operator x??=y arithmetic operation and assignment - Conditional
Operator x?y:z if...then...else conditional - Decrement
Operator x--, --x decrements a stored value - Define
Operator x:=y creates a new node - delete
Operator delete x.y deletes an object property - Divide
Operator x/y numeric division - Do Primitive
Operator, @x executes a primitive - Equal
Operator x==y compares for equality - Factorial
Operator x! factorial of a number - Function Call
Operator x() calls a function - Greater than
Operator x>y compares two objects - Greater than or equal
Operator x>=y compares two objects - Implied Multiply
The Multiply operator can be omitted in expressions where a number is followed by a constant or function - Increment
Operator x++, ++x increments a stored value - Left Shift
Operator x<<y shifts bits in a number left - Less Than
Operator x<y compares two objects - Less Than or Equal
Operator x<=y compares two objects - List Concatenate
Operator x!!y combines two lists - List Element
Operator x[y] returns zero-based element(s) in a list - List Literal
Operator [x,y,...] creates a list - Logical And
Operator x&&y logical And - Logical Not
Operator !x logical Not - Logical Or
Operator x||y logical Or - Minus
Operator -x identifies a number as negative - Multiply
Operator x*y numeric multiplication - new
Operator new x() creates a new object - Not Equal
Operator x!=y compares for inequality - Object Literal
Operator {p1:x,p2:y,...} creates an object - Parentheses
Operator (x,y,...) evaluates a series of steps in the current namespace - Percent
Operator x% divide by 100 - Plus
Identifies the number x as positive - Power
Operator x^y is x raised to the power y - Procedure
Operator {x,y,...} evaluates a series of steps in a new namespace - Property
Operator x.y accesses a named property in an object - Quote
Operator "x" specifies a text string - Range
Operator x..y creates a list of numbers from x to y - Remainder
Operator x%y remainder of x/y - Right Shift
Operator x>>y shifts bits in a number right - Subscript
Operator x#y returns one-based element(s) in a list - Subtract
Operator x-y numeric or matrix subtraction - Time Assignment
Operator x?=y assigns a time to a node value - Time Value
Operator x{y} value of x at time y in a time-based analysis - typeof
Operator typeof x returns the data type of x - Value Of
Operator ?x value assigned to a constant - void
Operator void x discards an expression's value - Zero-Fill Right Shift
Operator x>>>y shifts bits in a number right with sign
Units
Acre, area unit of measure - amp
Ampere, electric current unit of measure - angstrom
Angstrom, length unit of measure - atan
2-quadrant arc tangent - atan2
4-quadrant arc tangent - atm
Atmosphere, pressure unit of measure - bar
Bar, pressure unit of measure - btu
British Thermal Unit, energy unit of measure - cal
Calorie, energy unit of measure - cd
Candela, luminous intensity unit of measure - cm
Centimeter, length unit of measure - coul
Coulomb, electrostatic charge unit of measure - Dollar
Dollar, currency unit of measure - dyne
Dyne, force unit of measure - erg
Erg, energy unit of measure - ev
Electron Volt, energy unit of measure - farad
Farad, electric capacitance unit of measure - fl_oz
Fluid Ounce, volume unit of measure - ft
Foot, length unit of measure - gal
Gallon, volume unit of measure - gauss
Gauss, magnetic field unit of measure - gm
Gram, mass unit of measure - gmf
Gram, force unit of measure - gravity
Gravity, acceleration unit of measure - hectare
Hectare, area unit of measure - henry
Henry, inductance unit of measure - hp
Horsepower, power unit of measure - hr
Hour, time unit of measure - hz
Hertz, frequency unit of measure - in
Inch, length unit of measure - joule
Joule, energy unit of measure - kcal
Kilo Calorie, energy unit of measure - kelvin
Kelvin, temperature unit of measure - kg
Kilogram, mass unit of measure - kgf
Kilogram, force unit of measure - km
Kilometer, length unit of measure - knot
Knot, speed unit of measure - kph
Kilometer Per Hour, speed unit of measure - kw
Kilowatt, power unit of measure - lb
Pound, mass unit of measure - lbf
Pound, force unit of measure - liter
Liter, volume unit of measure - m
Meter, length unit of measure - maxwell
Maxwell, magnetic flux unit of measure - mev
Million Electron Volt, energy unit of measure - mg
Milligram, mass unit of measure - mi
Mile, length unit of measure - ml
Milliliter, volume unit of measure - mm
Millimeter, length unit of measure - mn
Minutes, time unit of measure - mo
Months, time unit of measure - mol
Mole, amount of substance unit of measure - mph
Mile Per Hour, speed unit of measure - newton
Newton, force unit of measure - ohm
Ohm, electric resistance unit of measure - oz
Ounce, mass unit of measure - ozf
Ounce, force unit of measure - pa
Pascal, pressure unit of measure - psi
Pound per Square Inch, pressure unit of measure - pt
Pint, volume unit of measure - qtr
Quarter of a year, time unit of measure - sec
Second, time unit of measure - siemens
Siemens, electric conductance unit of measure - slug
Slug, mass unit of measure - tesla
Tesla, magnetic field unit of measure - ton
Ton, mass unit of measure - tonf
Ton, force unit of measure - volt
Operator void x, discards an expression's value - watt
Watt, power unit of measure - weber
Weber, magnetic flux unit of measure - wk
Weeks, time unit of measure - yd
Yard, length unit of measure - yr
Years, time unit of measure