simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

classes.md (3148B)

      1 
      2 # Class Reference
      3 
      4 This page lists all the various class types in Math.js. Every top-level function is listed here and links to its detailed reference to other parts of the documentation.
      5 
      6 ## math
      7 
      8 The "math" namespace contains the entire math.js functionality. All of the mathematical functions are available in the "math" namespace, and allow for inputs of various types.
      9 
     10 - [Function reference](functions.md)
     11 - [Constant reference](constants.md)
     12 
     13 
     14 ## Unit
     15 
     16 Stores values for a scalar unit and its postfix. (eg `100 mm` or `100 kg`). Although the `Unit` class contains public functions documented as follows, using the following API directly is *not* recommended. Prefer using the functions in the "math" namespace wherever possible.
     17 
     18 - [Overview](../datatypes/units.md)
     19 - [Class API](classes/unit.md)
     20 
     21 
     22 ## Fraction
     23 
     24 Stores values for a fractional number.
     25 
     26 - [Overview](../datatypes/fractions.md)
     27 - [Class API](https://github.com/infusion/Fraction.js/)
     28 
     29 ## BigNumber
     30 
     31 Stores values for a arbitrary-precision floating point number.
     32 
     33 - [Overview](../datatypes/bignumbers.md)
     34 - [Class API](https://mikemcl.github.io/decimal.js/)
     35 
     36 
     37 ## Matrix
     38 
     39 Two types of matrix classes are available in math.js, for storage of dense and sparse matrices. Although they contain public functions documented as follows, using the following API directly is *not* recommended. Prefer using the functions in the "math" namespace wherever possible.
     40 
     41 - [Overview](../datatypes/matrices.md)
     42 - [DenseMatrix](classes/densematrix.md)
     43 - [SparseMatrix](classes/sparsematrix.md)
     44 
     45 Classes used internally that may be of use to developers:
     46 
     47 - [Index](classes/matrixindex.md)
     48 - [Range](classes/matrixrange.md)
     49 - [ResultSet](classes/matrixrange.md)
     50 - [FibonacciHeap](classes/fibonacciheap.md)
     51 
     52 ## Complex
     53 
     54 Stores values for a complex number.
     55 
     56 - [Overview](../datatypes/complex_numbers.md)
     57 - [Class API](https://github.com/infusion/Complex.js/)
     58 
     59 ## Parser
     60 
     61 The Parser object returned by `math.parser()`.
     62 
     63 - [Overview](../expressions/parsing.md)
     64 
     65 ## Node
     66 
     67 A node in an expression-tree, which can be used to analyze, manipulate, and evaluate expressions.
     68 
     69 - [Overview](../expressions/expression_trees.md)
     70 
     71 `Node` is the base class of all other node classes:
     72 
     73 - [AccessorNode](../expressions/expression_trees.md#accessornode)
     74 - [ArrayNode](../expressions/expression_trees.md#arraynode)
     75 - [AssignmentNode](../expressions/expression_trees.md#assignmentnode)
     76 - [BlockNode](../expressions/expression_trees.md#blocknode)
     77 - [ConditionalNode](../expressions/expression_trees.md#conditionalnode)
     78 - [ConstantNode](../expressions/expression_trees.md#constantnode)
     79 - [FunctionAssignmentNode](../expressions/expression_trees.md#functionassignmentnode)
     80 - [FunctionNode](../expressions/expression_trees.md#functionnode)
     81 - [IndexNode](../expressions/expression_trees.md#indexnode)
     82 - [ObjectNode](../expressions/expression_trees.md#objectnode)
     83 - [OperatorNode](../expressions/expression_trees.md#operatornode)
     84 - [ParenthesisNode](../expressions/expression_trees.md#parenthesisnode)
     85 - [RangeNode](../expressions/expression_trees.md#rangenode)
     86 - [SymbolNode](../expressions/expression_trees.md#symbolnode)