Nerdamer

https://nerdamer.com/documentation
Admin
Nerdamer is a small and light-weight symbolic math expression evaluator written in JavaScript. The...
Tokens:2,850
Snippets:26
Trust Score:8.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Trigonometric Functions

Source: https://nerdamer.com/documentation.html

Standard trigonometric functions and their inverses.

```APIDOC
## Trigonometric Functions

### Basic Trig
- `cos(expression)`
- `sin(expression)`
- `tan(expression)`
- `sec(expression)`
- `csc(expression)`
- `cot(expression)`

### Inverse Trig
- `acos(expression)`
- `asin(expression)`
- `atan(expression)`
- `atan2(y, x)`
- `acsc(expression)`
- `acot(expression)`
- `asec(expression)
```

--------------------------------

### General Math Functions

Source: https://nerdamer.com/documentation.html

A collection of common mathematical functions.

```APIDOC
## Math Functions

- `log(expression)`: Natural logarithm.
- `log10(expression)`: Base-10 logarithm.
- `min(expr1, expr2, ...)`: Returns the minimum of the arguments.
- `max(expr1, expr2, ...)`: Returns the maximum of the arguments.
- `abs(expression)`: Absolute value.
- `floor(expression)`: Floor function.
- `ceil(expression)`: Ceiling function.
- `simplify(expression)`: Simplifies an expression.
- `Si(expression)`: Sine integral.
- `Ci(expression)`: Cosine integral.
- `Ei(expression)`: Exponential integral.
- `rect(expression)`: Rectangular function.
- `step(expression)`: Heaviside step function.
- `sinc(expression)`: Sinc function.
- `Shi(expression)`: Hyperbolic sine integral.
- `Chi(expression)`: Hyperbolic cosine integral.
- `fact(expression)`: Factorial.
- `factorial(expression)`: Factorial.
- `dfactorial(expression)`: Double factorial.
- `exp(expression)`: Exponential function (e^x).
- `mod(expression1, expression2)`: Modulo operation.
- `erf(expression)`: Error function.
- `sign(expression)`: Sign function.
- `round(expression)`: Rounds to the nearest integer.
- `pfactor(expression)`: Prime factorization.
- `sqrt(expression)`: Square root.
- `expand(expression)`: Expands an expression.
- `fib(n)`: Fibonacci number.
- `tri(n)`: Triangular number.
- `parens(expression)`: Adds parentheses if necessary.
- `line(expression)`: Represents a line.
- `continued_fraction(expression)`: Represents a continued fraction.
```

--------------------------------

### Hyperbolic Trigonometric Functions

Source: https://nerdamer.com/documentation.html

Hyperbolic trigonometric functions and their inverses.

```APIDOC
## Hyperbolic Trig Functions

### Basic Hyperbolic
- `cosh(expression)`
- `sinh(expression)`
- `tanh(expression)`
- `sech(expression)`
- `csch(expression)`
- `coth(expression)`

### Inverse Hyperbolic
- `acosh(expression)`
- `asinh(expression)`
- `atanh(expression)`
- `asech(expression)`
- `acsch(expression)`
- `acoth(expression)
```

--------------------------------

### Calculus Functions

Source: https://nerdamer.com/documentation.html

Functions for performing calculus operations like differentiation and integration.

```APIDOC
## Calculus Functions

- `sum(expression, variable, start, end)`: Calculates summation.
- `product(expression, variable, start, end)`: Calculates product.
- `diff(expression, variable, order)`: Calculates the derivative.
- `integrate(expression, variable, start, end)`: Calculates the indefinite or definite integral.
- `defint(expression, variable, start, end)`: Calculates the definite integral.
```

--------------------------------

### Matrix and Vector Operations

Source: https://nerdamer.com/documentation.html

Functions for creating and manipulating matrices and vectors.

```APIDOC
## Matrix and Vector Operations

### Matrix Creation
- `matrix(rows, cols, fill)`: Creates a matrix.
- `imatrix(rows, cols)`: Creates an identity matrix.

### Matrix Manipulation
- `determinant(matrix)`: Calculates the determinant.
- `matget(matrix, row, col)`: Gets an element from the matrix.
- `matset(matrix, row, col, value)`: Sets an element in the matrix.
- `invert(matrix)`: Inverts the matrix.
- `transpose(matrix)`: Transposes the matrix.
- `matgetcol(matrix, colIndex)`: Gets a column from the matrix.
- `matgetrow(matrix, rowIndex)`: Gets a row from the matrix.
- `matsetcol(matrix, colIndex, vector)`: Sets a column in the matrix.
- `matsetrow(matrix, rowIndex, vector)`: Sets a row in the matrix.
- `size(matrix)`: Returns the dimensions of the matrix.

### Vector Operations
- `vector(elements)`: Creates a vector.
- `vecget(vector, index)`: Gets an element from the vector.
- `vecset(vector, index, value)`: Sets an element in the vector.
- `cross(vector1, vector2)`: Calculates the cross product.
- `dot(vector1, vector2)`: Calculates the dot product.
```

--------------------------------

### Algebra Functions

Source: https://nerdamer.com/documentation.html

Functions for algebraic manipulation, including factoring, division, and solving polynomial equations.

```APIDOC
## Algebra Functions

- `divide(numerator, denominator)`: Divides two expressions.
- `factor(expression)`: Factors an expression.
- `partfrac(expression, variable)`: Performs partial fraction decomposition.
- `lcm(expr1, expr2, ...)`: Calculates the least common multiple.
- `gcd(expr1, expr2, ...)`: Calculates the greatest common divisor.
- `roots(expression, variable)`: Finds the roots of a polynomial.
- `coeffs(expression, variable)`: Returns the coefficients of a polynomial.
- `deg(expression, variable)`: Returns the degree of a polynomial.
- `sqcomp(expression, variable)`: Completes the square for a quadratic expression.
```

--------------------------------

### Expression Object API

Source: https://nerdamer.com/documentation.html

API for interacting with expression objects, including building functions, evaluation, substitution, and arithmetic operations.

```APIDOC
## Expression Object API

### Core Methods
- `buildFunction(expression, variables)`: Builds a function from an expression.
- `evaluate(expression)`: Evaluates an expression.
- `sub(expression, variable, value)`: Substitutes a value for a variable.

### Operations
- `add(expr1, expr2)`
- `subtract(expr1, expr2)`
- `multiply(expr1, expr2)`
- `divide(expr1, expr2)`
- `pow(base, exponent)`
- `variables(expression)`: Returns the variables in an expression.
- `toTeX(expression)`: Converts expression to TeX format.
- `text(expression)`: Returns the string representation of the expression.
- `denominator(expression)`: Returns the denominator of a fraction.
- `numerator(expression)`: Returns the numerator of a fraction.

### Equality
- `eq(expr1, expr2)`: Checks for equality.
- `lt(expr1, expr2)`: Checks if expr1 is less than expr2.
- `gt(expr1, expr2)`: Checks if expr1 is greater than expr2.
- `lte(expr1, expr2)`: Checks if expr1 is less than or equal to expr2.
- `gte(expr1, expr2)`: Checks if expr1 is greater than or equal to expr2.
```

--------------------------------

### Solve Functions

Source: https://nerdamer.com/documentation.html

Functions for solving equations and systems of equations.

```APIDOC
## Solve Functions

- `solve(equation, variable)`: Solves a single equation for a variable.
- `solveEquations(equations, variables)`: Solves a system of equations.
- `solveFor(expression, variable, value)`: Solves for a variable given a specific value or condition.
```

--------------------------------

### Extra Functions

Source: https://nerdamer.com/documentation.html

Additional utility functions including Laplace transforms, statistical measures, and limits.

```APIDOC
## Extra Functions

- `laplace(expression, time, frequency)`: Calculates the Laplace transform.
- `ilt(expression, frequency, time)`: Calculates the inverse Laplace transform.
- `mean(data)`: Calculates the mean of a dataset.
- `mode(data)`: Calculates the mode of a dataset.
- `median(data)`: Calculates the median of a dataset.
- `zscore(value, data)`: Calculates the z-score.
- `limit(expression, variable, point)`: Calculates the limit of an expression.
- `smpvar(data)`: Calculates the sample variance.
- `variance(data)`: Calculates the population variance.
- `smpstdev(data)`: Calculates the sample standard deviation.
- `stdev(data)`: Calculates the population standard deviation.
```

--------------------------------

### Call core functions directly using nerdamer API

Source: https://nerdamer.com/documentation.html

As an alternative to parsing strings, core functions can be called directly through the nerdamer object. This provides a more direct API for common operations.

```javascript
var x = nerdamer.diff('sin(x)/x', 'x');
```

--------------------------------

### Core Functions

Source: https://nerdamer.com/documentation.html

Core functionalities of the Nerdamer library, including version, constants, functions, variable management, and expression manipulation utilities.

```APIDOC
## Core Functions

### nerdamer
- `nerdamer(expression)`: Parses and evaluates a mathematical expression.
- `nerdamer.version`: Returns the current version of the library.
- `nerdamer.setConstant(name, value)`: Sets a mathematical constant.
- `nerdamer.setFunction(name, func)`: Registers a new function.
- `nerdamer.getCore()`: Returns the core library object.
- `nerdamer.reserved`: Object containing reserved keywords.
- `nerdamer.expressions`: Object for managing expressions.
- `nerdamer.register(plugin)`: Registers a plugin.
- `nerdamer.validVarName(name)`: Checks if a name is a valid variable name.
- `nerdamer.setVar(name, value)`: Sets a variable.
- `nerdamer.clearVars()`: Clears all defined variables.
- `nerdamer.getVars()`: Returns all defined variables.
- `nerdamer.set(name, value)`: Sets a value (similar to setVar).
- `nerdamer.tree(expression)`: Returns the expression tree.
- `nerdamer.htmlTree(expression)`: Returns the expression tree in HTML format.
- `nerdamer.flush()`: Clears the cache.
- `nerdamer.convertToLaTeX(expression)`: Converts an expression to LaTeX format.
- `nerdamer.convertFromLaTeX(latex)`: Converts a LaTeX string to an expression.
```

--------------------------------

### Parse mathematical expression using nerdamer

Source: https://nerdamer.com/documentation.html

Use the nerdamer object to parse a mathematical expression string. This is the primary way to interact with the library's core functionality.

```javascript
var x = nerdamer('diff(sin(x)/x, x)');
```

--------------------------------

### Imaginary Number Functions

Source: https://nerdamer.com/documentation.html

Functions for working with complex numbers in polar and rectangular forms.

```APIDOC
## Imaginary Number Functions

- `polarform(expression)`: Converts to polar form.
- `rectform(expression)`: Converts to rectangular form.
- `arg(expression)`: Returns the argument (angle) of a complex number.
- `imagpart(expression)`: Returns the imaginary part of a complex number.
- `realpart(expression)`: Returns the real part of a complex number.
```
Tokens:
Raw