Primitive Description Format
Primitive descriptions follow a consistent format to define the function of each primitive, which are listed below. All primitive descriptions include the categories Format, Arguments, and Returns. Additional categories (Description, Note, Examples, and See also) are included with those primitives requiring additional explanation.
Primitive Description Format
| Format | Description |
|---|---|
| Format | Illustrates the primitive's basic syntax. Argument names, which you substitute with your specific input values, are presented in italic text. Some primitives have optional arguments represented in non-bold text. Optional arguments can be omitted when using a primitive in order to reduce the amount of information you must type. In these cases, default values are used. Optional arguments are omitted by truncating the argument list, not by leaving an argument's position blank. For example, the third argument in the command graph(Y,X,,"Title") is not omitted; it has been implicitly assigned the value null. In contrast, the fifth and sixth arguments have been omitted in this example. |
| Arguments | Describes what each input argument in the primitive's format is intended to represent. See Arguments. |
| Returns | Describes the value returned by the primitive. The data type codes described in the Arguments section are used here also to indicate the type of data returned. |
| Description | Provides the basic function of the primitive, suggestions on how it can be used, and/or details about how the primitive performs its function. |
| Note | Presents details about a primitive's limitations or peculiarities not directly related to the primitive's basic function. |
| Examples | Illustrates the primitive's basic operation using examples. The examples display exactly as you should type them in a formula. The result of the example is presented to the right, separated from the example text using an equal symbol (=). |
| See also | Lists related primitives frequently used in conjunction with the current primitive or that may better fit the task you want to perform. |