codac 2.0.0
Loading...
Searching...
No Matches
codac2::symbolic::detail::ScalarBridgeContext Class Reference

Context gathering the bridge objects needed for one scalar transformation. More...

#include <codac2_sympy_bridge.h>

Public Member Functions

 ScalarBridgeContext (const FunctionArgsList &args)
 Builds a scalar bridge context for a given function argument list.
const pybind11::object & sympy () const
 Returns the imported SymPy module.
const FlatSymbolTablesymbols () const
 Returns the associated flat symbol table.
pybind11::object export_scalar (const ScalarExpr &y) const
 Exports a Codac scalar expression to SymPy.
ScalarExpr import_scalar (const pybind11::handle &obj) const
 Imports a SymPy scalar expression into Codac.
ScalarExpr transform_scalar_expr (const ScalarExpr &y, const SympyTransform &transform, bool do_expand=true) const
 Applies a SymPy transformation to a Codac scalar expression.

Detailed Description

Context gathering the bridge objects needed for one scalar transformation.

Constructor & Destructor Documentation

◆ ScalarBridgeContext()

codac2::symbolic::detail::ScalarBridgeContext::ScalarBridgeContext ( const FunctionArgsList & args)
explicit

Builds a scalar bridge context for a given function argument list.

Parameters
argsFunction argument list.

Member Function Documentation

◆ sympy()

const pybind11::object & codac2::symbolic::detail::ScalarBridgeContext::sympy ( ) const

Returns the imported SymPy module.

Returns
SymPy module.

◆ symbols()

const FlatSymbolTable & codac2::symbolic::detail::ScalarBridgeContext::symbols ( ) const

Returns the associated flat symbol table.

Returns
Flat symbol table.

◆ export_scalar()

pybind11::object codac2::symbolic::detail::ScalarBridgeContext::export_scalar ( const ScalarExpr & y) const

Exports a Codac scalar expression to SymPy.

Parameters
yCodac scalar expression.
Returns
Corresponding SymPy expression.

◆ import_scalar()

ScalarExpr codac2::symbolic::detail::ScalarBridgeContext::import_scalar ( const pybind11::handle & obj) const

Imports a SymPy scalar expression into Codac.

Parameters
objSymPy expression handle.
Returns
Corresponding Codac scalar expression.

◆ transform_scalar_expr()

ScalarExpr codac2::symbolic::detail::ScalarBridgeContext::transform_scalar_expr ( const ScalarExpr & y,
const SympyTransform & transform,
bool do_expand = true ) const

Applies a SymPy transformation to a Codac scalar expression.

Parameters
yCodac scalar expression.
transformSymPy transformation.
do_expandWhether the transformed expression should be expanded.
Returns
Transformed Codac scalar expression.

The documentation for this class was generated from the following file: