Function reference • caracas

Main functions Main functions.
`N()`	Numerical evaluation
`all_vars()`	All variables
`as_character()`	Coerce symbol to character
`as_expr()` `as.expression(<caracas_symbol>)` `as.expression(<caracas_solve_sys_sol>)`	Convert caracas object to R
`as_func()` `as.function(<caracas_symbol>)`	Convert expression into function object.
`as_sym()`	Convert R object to caracas symbol
`def_sym()` `def_sym_vec()`	Define (invisibly) caracas symbols in global environment
`doit()`	Perform calculations setup previously
`fraction_parts()` `numerator()` `denominator()`	Get numerator and denominator of a fraction
`free_symbols()`	Get free symbol in expression
`is_sym()`	Is object a caracas symbol
`listify()`	Convert object to list of elements
`ls_sym()`	List defined symbols
`matrify()`	Creates matrix from array symbol
`subs()`	Substitute symbol for value
`sym_inherits()`	Ask if type of caracas symbol is of a requested type
`symbol()`	Create a symbol
`symbol_class()`	Ask type of caracas symbol
`sympy_func()`	Call a SymPy function directly on x
`to_list()` `to_vector()` `to_matrix()`	Coerce caracas object
`tuplify()`	Convert object to tuple
`unbracket()`	Remove inner-most dimension
`vectorfy()`	Creates symbol vector from list of caracas symbols
Basic algebra Functions related to simple operations.
`Math(<caracas_symbol>)`	Math functions
`Ops(<caracas_symbol>)`	Math operators
Vector Functions related to vectors.
`cumsum(<caracas_symbol>)`	Cumulative Sums
`diag<-`(<caracas_symbol>)	Replace diagonal
`[`(<caracas_symbol>)	Extract or replace parts of an object
`[<-`(<caracas_symbol>)	Extract or replace parts of an object
`sum(<caracas_symbol>)`	Summation
Simplification Functions related to simplifying and expanding expressions.
`apart()`	Partial fraction decomposition on a rational function
`cancel()`	Put rational function into standard form
`collect()`	Collects common powers of a term in an expression
`expand()`	Expand expression
`expand_func()`	Expand a function expression
`expand_log()`	Expand a logarithmic expression
`expand_trig()`	Expand a trigonometric expression
`factor_()`	Expand expression
`simplify()`	Simplify expression
Calculus Functions related to calculus.
`der()`	Symbolic differentiation of an expression
`der2()`	Symbolic differentiation of second order of an expression
`drop_remainder()`	Remove remainder term
`int()`	Integrate a function
`jacobian()`	Compute Jacobian
`lim()`	Limit of a function
`prod_()`	Product of a function
`score()` `hessian()`	Score and Hessian matrix
`sum_()`	Sum of a function
`taylor()`	Taylor expansion
Linear algebra Functions related to linear algebra.
`add_prefix()`	Add prefix to each element of matrix
`as_character_matrix()`	Get matrix as character matrix
`as_diag()`	Construct diagonal matrix from vector
`as_vec()`	Stacks matrix to vector
`colspan()`	Column space (range) of a symbolic matrix
`diag<-`()	Replace matrix diagonal
`diag()`	Matrix diagonal
`diag(<caracas_symbol>)`	Matrix diagonal
`diag_()`	Symbolic diagonal matrix
`diff_mat()`	Difference matrix
`dim<-`(<caracas_symbol>)	Dimensions of a caracas symbol
`dim(<caracas_symbol>)`	Dimensions of a caracas symbol
`do_la()`	Do linear algebra operation
`vector_sym()` `matrix_sym()` `matrix_sym_diag()` `matrix_sym_symmetric()`	Generate generic vectors and matrices
`get_basis()`	Get basis
`kronecker(<caracas_symbol>,<caracas_symbol>)`	Kronecker product of two matrices
`columnspace()` `nullspace()` `rowspace()` `singular_values()` `inv()` `eigenval()` `eigenvec()` `GramSchmidt()` `pinv()` `rref()` `QRdecomposition()` `LUdecomposition()` `chol(<caracas_symbol>)` `svd_()` `det()` `trace_()`	Do linear algebra operation
`mat_pow()`	Matrix power
`%*%`	Matrix multiplication
`matrix_()`	Symbolic matrix
`crossprod_()` `tcrossprod_()`	Matrix cross product
`rankMatrix_()`	Rank of matrix
`reciprocal_matrix()`	Elementwise reciprocal matrix
`rowSums_()` `colSums_()`	Form Row and Column Sums
`scale_matrix()`	Create list of factors as in a product
`zeros_sym()` `ones_sym()` `eye_sym()`	Special matrices: zeros_sym, ones_sym, eye_sym
`symbol_is_matrix()`	Check if object is a caracas matrix
`t(<caracas_symbol>)`	Transpose of matrix
`unscale_matrix()`	Extract matrix from scaled matrix
Solve Functions related to solving equations
`solve(<caracas_symbol>)`	Solve a System of Linear Equations
`solve_lin()`	Solve a linear system of equations
`solve_sys()`	Solves a system of non-linear equations
Output Functions related to output.
`as.character(<caracas_symbol>)`	Convert symbol to character
`print(<caracas_scaled_matrix>)`	Print scaled matrix
`print(<caracas_solve_sys_sol>)`	Print solution
`print(<caracas_symbol>)`	Print symbol
`tex()`	Export object to TeX
`tex(<caracas_scaled_matrix>)`	Export scaled matrix to tex
`texshow()`	Dump latex representation of sympy object.
Low level functions These are various utility functions that are normally only called by advanced users.
`eval_to_symbol()`	Create a symbol from a string
Assumptions These are functions to deal with symbol assumptions.
`ask()`	Ask for a symbol's property
SymPy These are functions to interact with SymPy, including installation and getting SymPy version.
`get_py()`	Access 'py' object
`get_sympy()`	Access 'SymPy' directly
`has_sympy()`	Check if 'SymPy' is available
`install_sympy()`	Install 'SymPy'
`sympy_version()`	Get 'SymPy' version
Others These are functions not mentioned above.
`%>%`	Pipe
`sym_class()`	Ask type of caracas symbol
Complete reference
`Math(<caracas_symbol>)`	Math functions
`N()`	Numerical evaluation
`Ops(<caracas_symbol>)`	Math operators
`add_prefix()`	Add prefix to each element of matrix
`all_vars()`	All variables
`apart()`	Partial fraction decomposition on a rational function
`as.character(<caracas_symbol>)`	Convert symbol to character
`as_character()`	Coerce symbol to character
`as_character_matrix()`	Get matrix as character matrix
`as_diag()`	Construct diagonal matrix from vector
`as_expr()` `as.expression(<caracas_symbol>)` `as.expression(<caracas_solve_sys_sol>)`	Convert caracas object to R
`as_func()` `as.function(<caracas_symbol>)`	Convert expression into function object.
`as_sym()`	Convert R object to caracas symbol
`as_vec()`	Stacks matrix to vector
`ask()`	Ask for a symbol's property
`cancel()`	Put rational function into standard form
`collect()`	Collects common powers of a term in an expression
`colspan()`	Column space (range) of a symbolic matrix
`cumsum(<caracas_symbol>)`	Cumulative Sums
`def_sym()` `def_sym_vec()`	Define (invisibly) caracas symbols in global environment
`der()`	Symbolic differentiation of an expression
`der2()`	Symbolic differentiation of second order of an expression
`diag<-`(<caracas_symbol>)	Replace diagonal
`diag<-`()	Replace matrix diagonal
`diag()`	Matrix diagonal
`diag(<caracas_symbol>)`	Matrix diagonal
`diag_()`	Symbolic diagonal matrix
`diff_mat()`	Difference matrix
`dim<-`(<caracas_symbol>)	Dimensions of a caracas symbol
`dim(<caracas_symbol>)`	Dimensions of a caracas symbol
`do_la()`	Do linear algebra operation
`doit()`	Perform calculations setup previously
`drop_remainder()`	Remove remainder term
`eval_to_symbol()`	Create a symbol from a string
`expand()`	Expand expression
`expand_func()`	Expand a function expression
`expand_log()`	Expand a logarithmic expression
`expand_trig()`	Expand a trigonometric expression
`factor_()`	Expand expression
`fraction_parts()` `numerator()` `denominator()`	Get numerator and denominator of a fraction
`free_symbols()`	Get free symbol in expression
`vector_sym()` `matrix_sym()` `matrix_sym_diag()` `matrix_sym_symmetric()`	Generate generic vectors and matrices
`get_basis()`	Get basis
`get_py()`	Access 'py' object
`get_sympy()`	Access 'SymPy' directly
`has_sympy()`	Check if 'SymPy' is available
`install_sympy()`	Install 'SymPy'
`int()`	Integrate a function
`is_sym()`	Is object a caracas symbol
`jacobian()`	Compute Jacobian
`kronecker(<caracas_symbol>,<caracas_symbol>)`	Kronecker product of two matrices
`lim()`	Limit of a function
`columnspace()` `nullspace()` `rowspace()` `singular_values()` `inv()` `eigenval()` `eigenvec()` `GramSchmidt()` `pinv()` `rref()` `QRdecomposition()` `LUdecomposition()` `chol(<caracas_symbol>)` `svd_()` `det()` `trace_()`	Do linear algebra operation
`listify()`	Convert object to list of elements
`ls_sym()`	List defined symbols
`mat_pow()`	Matrix power
`matrify()`	Creates matrix from array symbol
`%*%`	Matrix multiplication
`matrix_()`	Symbolic matrix
`crossprod_()` `tcrossprod_()`	Matrix cross product
`%>%`	Pipe
`print(<caracas_scaled_matrix>)`	Print scaled matrix
`print(<caracas_solve_sys_sol>)`	Print solution
`print(<caracas_symbol>)`	Print symbol
`prod_()`	Product of a function
`rankMatrix_()`	Rank of matrix
`reciprocal_matrix()`	Elementwise reciprocal matrix
`rowSums_()` `colSums_()`	Form Row and Column Sums
`scale_matrix()`	Create list of factors as in a product
`score()` `hessian()`	Score and Hessian matrix
`simplify()`	Simplify expression
`solve(<caracas_symbol>)`	Solve a System of Linear Equations
`solve_lin()`	Solve a linear system of equations
`solve_sys()`	Solves a system of non-linear equations
`zeros_sym()` `ones_sym()` `eye_sym()`	Special matrices: zeros_sym, ones_sym, eye_sym
`[`(<caracas_symbol>)	Extract or replace parts of an object
`subs()`	Substitute symbol for value
`[<-`(<caracas_symbol>)	Extract or replace parts of an object
`sum(<caracas_symbol>)`	Summation
`sum_()`	Sum of a function
`sym_class()`	Ask type of caracas symbol
`sym_inherits()`	Ask if type of caracas symbol is of a requested type
`symbol()`	Create a symbol
`symbol_class()`	Ask type of caracas symbol
`symbol_is_matrix()`	Check if object is a caracas matrix
`sympy_func()`	Call a SymPy function directly on x
`sympy_version()`	Get 'SymPy' version
`t(<caracas_symbol>)`	Transpose of matrix
`taylor()`	Taylor expansion
`tex()`	Export object to TeX
`tex(<caracas_scaled_matrix>)`	Export scaled matrix to tex
`texshow()`	Dump latex representation of sympy object.
`to_list()` `to_vector()` `to_matrix()`	Coerce caracas object
`tuplify()`	Convert object to tuple
`unbracket()`	Remove inner-most dimension
`unscale_matrix()`	Extract matrix from scaled matrix
`vectorfy()`	Creates symbol vector from list of caracas symbols

Reference

Main functions

Basic algebra

Vector

Simplification

Calculus

Linear algebra

Solve

Output

Low level functions

Assumptions

SymPy

Others

Complete reference