C++ Documentation

Class Hierarchy

• • Namespace tfc
    • Namespace tfc::utils
      • Namespace tfc::utils::BF_Py
        • Class BasisFunc
        • Class CP
        • Class ELM
        • Class ELMReLU
        • Class ELMSigmoid
        • Class ELMSin
        • Class ELMSwish
        • Class ELMTanh
        • Class FS
        • Class HoPphy
        • Class HoPpro
        • Class LaP
        • Class LeP
        • Class nBasisFunc
        • Class nCP
        • Class nELM
        • Class nELMReLU
        • Class nELMSigmoid
        • Class nELMSin
        • Class nELMSwish
        • Class nELMTanh
        • Class nFS
        • Class nLeP
      • Namespace tfc::utils::CeSolver
        • Class CeSolver
        • Class TfcPrinter
      • Namespace tfc::utils::Html
        • Class Dot
        • Class HTML
      • Namespace tfc::utils::Latex
        • Class table
      • Namespace tfc::utils::MakePlot
        • Class MakePlot
      • Namespace tfc::utils::MayaviMakePlot
        • Class MakePlot
      • Namespace tfc::utils::PlotlyMakePlot
        • Class MakePlot
      • Namespace tfc::utils::TFCUtils
        • Class ComponentConstraintDict
        • Class ComponentConstraintGraph
        • Class LsClass
        • Class NllsClass
        • Class TFCDict
        • Class TFCDictRobust
        • Class TFCPrint
  • Class BasisFunc
  • Class CP
  • Class ELM
  • Class ELMReLU
  • Class ELMSigmoid
  • Class ELMSin
  • Class ELMSwish
  • Class ELMTanh
  • Class FS
  • Class HoPphy
  • Class HoPpro
  • Class LaP
  • Class LeP
  • Class nBasisFunc
  • Class nCP
  • Class nELM
  • Class nELMReLU
  • Class nELMSigmoid
  • Class nELMSin
  • Class nELMSwish
  • Class nELMTanh
  • Class nFS
  • Class nLeP

File Hierarchy

• • File __init__.py
  • File BF.cc
  • File BF.h
  • File BF_Py.cc
  • File BF_Py.py
  • File CeSolver.py
  • File Html.py
  • File Latex.py
  • File MakePlot.py
  • File MayaviMakePlot.py
  • File PlotlyMakePlot.py
  • File tfc_types.py
  • File TFCUtils.py

Full API

Namespaces

• Namespace tfc
  • Namespaces

• Namespace tfc::utils
  • Namespaces

• Namespace tfc::utils::BF_Py
  • Classes

• Namespace tfc::utils::CeSolver
  • Classes

• Namespace tfc::utils::Html
  • Classes

• Namespace tfc::utils::Latex
  • Classes

• Namespace tfc::utils::MakePlot
  • Classes

• Namespace tfc::utils::MayaviMakePlot
  • Classes
  • Variables

• Namespace tfc::utils::PlotlyMakePlot
  • Classes

• Namespace tfc::utils::tfc_types
  • Variables

• Namespace tfc::utils::TFCUtils
  • Classes
  • Functions
  • Variables

Classes and Structs

• Class BasisFunc
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • BasisFunc
      • BasisFunc()
      • ~BasisFunc()
      • BasisFunc()
      • operator=()
      • BasisFunc()
      • operator=()
      • H()
      • xla()
      • z0
      • x0
      • c
      • nC
      • numC
      • m
      • identifier
      • xlaCapsule
      • xlaGpuCapsule
      • nIdentifier
      • BasisFuncContainer
      • BasisFunc()
      • GetXlaCapsule()

• Class CP
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation
    • CP
      • CP()
      • ~CP()
      • CP()
      • operator=()
      • CP()
      • operator=()
      • CP()
      • Hint()
      • RecurseDeriv()

• Class ELM
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • ELM
      • ELM()
      • ~ELM()
      • getW()
      • setW()
      • getB()
      • setB()
      • w
      • b
      • Hint()
      • RecurseDeriv()

• Class ELMReLU
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • ELMReLU
      • ELMReLU()
      • ~ELMReLU()
      • Hint()

• Class ELMSigmoid
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • ELMSigmoid
      • ELMSigmoid()
      • ~ELMSigmoid()
      • Hint()

• Class ELMSin
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • ELMSin
      • ELMSin()
      • ~ELMSin()

• Class ELMSwish
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • ELMSwish
      • ELMSwish()
      • ~ELMSwish()

• Class ELMTanh
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • ELMTanh
      • ELMTanh()
      • ~ELMTanh()

• Class FS
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation
    • FS
      • FS()
      • FS()
      • ~FS()
      • Hint()
      • RecurseDeriv()

• Class HoPphy
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • HoPphy
      • HoPphy()
      • ~HoPphy()

• Class HoPpro
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • HoPpro
      • HoPpro()
      • ~HoPpro()

• Class LaP
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • LaP
      • LaP()
      • ~LaP()

• Class LeP
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation
    • LeP
      • LeP()
      • LeP()
      • ~LeP()
      • Hint()
      • RecurseDeriv()

• Class nBasisFunc
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • nBasisFunc
      • nBasisFunc()
      • ~nBasisFunc()
      • H()
      • xla()
      • getC()
      • z0
      • zf
      • c
      • x0
      • dim
      • numBasisFunc
      • numBasisFuncFull
      • nBasisFunc()

• Class nCP
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • nCP
      • nCP()
      • ~nCP()

• Class nELM
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • nELM
      • nELM()
      • ~nELM()
      • setW()
      • getW()
      • getB()
      • setB()
      • z0
      • zf
      • w
      • b

• Class nELMReLU
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • nELMReLU
      • nELMReLU()
      • ~nELMReLU()

• Class nELMSigmoid
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • nELMSigmoid
      • nELMSigmoid()
      • ~nELMSigmoid()

• Class nELMSin
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • nELMSin
      • nELMSin()
      • ~nELMSin()

• Class nELMSwish
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • nELMSwish
      • nELMSwish()
      • ~nELMSwish()

• Class nELMTanh
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • nELMTanh
      • nELMTanh()
      • ~nELMTanh()

• Class nFS
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • nFS
      • nFS()
      • ~nFS()

• Class nLeP
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • nLeP
      • nLeP()
      • ~nLeP()

• Class BasisFunc
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • __init__()
    • H()
    • c()
    • _Hint()
    • _m
    • _nC
    • _numC
    • _z0
    • _c
    • _x0

• Class CP
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation
    • __init__()
    • _Hint()
    • _m

• Class ELM
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • __init__()
    • w()
    • b()
    • w()
    • b()
    • _w
    • _b

• Class ELMReLU
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()
    • _b
    • _m

• Class ELMSigmoid
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()

• Class ELMSin
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()

• Class ELMSwish
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()

• Class ELMTanh
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()

• Class FS
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation
    • __init__()
    • _Hint()
    • _m

• Class HoPphy
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()
    • _m

• Class HoPpro
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()
    • _m

• Class LaP
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _Hint()
    • _m

• Class LeP
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation
    • __init__()
    • _Hint()
    • _m

• Class nBasisFunc
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • __init__()
    • c()
    • numBasisFunc()
    • numBasisFuncFull()
    • H()
    • _NumBasisFunc()
    • _m
    • _nC
    • _dim
    • _numC
    • _z0
    • _zf
    • _x0
    • _c
    • _numBasisFunc
    • _numBasisFuncFull

• Class nCP
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • __init__()

• Class nELM
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • __init__()
    • w()
    • b()
    • w()
    • b()
    • H()
    • _nHint()
    • _Hint()
    • _m
    • _nC
    • _dim
    • _numC
    • _z0
    • _zf
    • _x0
    • _c
    • _numBasisFunc
    • _numBasisFuncFull
    • _w
    • _b

• Class nELMReLU
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _nHint()
    • _m
    • _w
    • _b

• Class nELMSigmoid
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _nHint()

• Class nELMSin
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _nHint()

• Class nELMSwish
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _nHint()

• Class nELMTanh
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • _nHint()

• Class nFS
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • __init__()

• Class nLeP
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • __init__()

• Class CeSolver
  • Class Documentation
    • tfc::utils::CeSolver::CeSolver
      • __init__()
      • print_type()
      • print_type()
      • ce()
      • ce()
      • phi()
      • phi()
      • alpha()
      • S()
      • rho()
      • s()
      • s()
      • kappa()
      • kappa()
      • C()
      • C()
      • g()
      • g()
      • checkCe()
      • _solveCe()
      • _C
      • _K
      • _s
      • _g
      • _print_type
      • _ce_stale
      • _ce
      • _phi
      • _phi_stale
      • _alpha
      • _alpha_stale
      • _S
      • _S_stale
      • _rho
      • _rho_stale

• Class TfcPrinter
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • __init__()
    • _hprint_Pow()
    • _print_Symbol()
    • _print_Function()
    • _print_Subs()
    • _print_Derivative()

• Class Dot
  • Class Documentation
    • tfc::utils::Html::Dot
      • __init__()
      • Render()
      • dot
      • _outFile
      • _name

• Class HTML
  • Class Documentation
    • tfc::utils::Html::HTML
      • __init__()
      • GenerateHtml()
      • WriteFile()
      • ReadFile()
      • doc
      • tag
      • text
      • centerClass
      • _outFile

• Class table
  • Class Documentation
    • tfc::utils::Latex::table
      • SimpleTable()
      • _Header()
      • _colHeader()
      • _Arr2Tab()
      • _Footer()

• Class MakePlot
  • Class Documentation
    • tfc::utils::MakePlot::MakePlot
      • __init__()
      • FullScreen()
      • PartScreen()
      • show()
      • draw()
      • save()
      • savePickle()
      • saveAll()
      • animate()
      • fig
      • ax
      • twinAx

• Class MakePlot
  • Class Documentation
    • tfc::utils::MayaviMakePlot::MakePlot
      • __init__()
      • FullScreen()
      • PartScreen()
      • animate()
      • save()
      • show()
      • show_axes()
      • show_axes()
      • view()
      • points3d()
      • plot3d()
      • surf()
      • quiver3d()
      • mesh()
      • contour3d()
      • fig
      • scene
      • ColormapGradient()
      • SetColormapGradient()
      • IntRange
      • _str_to_rgb()
      • _str_to_rgba()
      • _ProcessKwargs()

• Class MakePlot
  • Class Documentation
    • tfc::utils::PlotlyMakePlot::MakePlot
      • __init__()
      • Surface()
      • Scatter3d()
      • Scatter()
      • Histogram()
      • Contour()
      • Box()
      • Violin()
      • Volume()
      • show()
      • save()
      • UploadToPlotly()
      • view()
      • FullScreen()
      • PartScreen()
      • NormalizeColorScale()
      • viewDistance
      • fig
      • _is3d
      • _hasSubplots
      • _template
      • _backgroundColor
      • _gridColor

• Class ComponentConstraintDict
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • name
    • node0
    • node1

• Class ComponentConstraintGraph
  • Class Documentation
    • tfc::utils::TFCUtils::ComponentConstraintGraph
      • __init__()
      • SaveGraphs()
      • nNodes
      • nEdges
      • targets
      • goodTargets
      • N
      • E

• Class LsClass
  • Class Documentation
    • tfc::utils::TFCUtils::LsClass
      • __init__()
      • run()
      • timerType
      • timer
      • holomorphic
      • _ls
      • _compiled

• Class NllsClass
  • Class Documentation
    • tfc::utils::TFCUtils::NllsClass
      • __init__()
      • run()
      • timerType
      • timer
      • holomorphic
      • _maxIter
      • _dictFlag
      • _nlls
      • _compiled

• Class TFCDict
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • __init__()
    • getSlices()
    • update()
    • toArray()
    • toDict()
    • block_until_ready()
    • __iadd__()
    • __isub__()
    • __add__()
    • __sub__()
    • _keys
    • _nKeys
    • _slices

• Class TFCDictRobust
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • __init__()
    • getSlices()
    • update()
    • toArray()
    • toDict()
    • block_until_ready()
    • __iadd__()
    • __isub__()
    • __add__()
    • __sub__()
    • _keys
    • _nKeys
    • _slices

• Class TFCPrint
  • Class Documentation
    • tfc::utils::TFCUtils::TFCPrint
      • __init__()
      • Error()
      • Warning()

Functions

• Template Function add1DInit
  • Function Documentation

• Template Function addNdElmInit
  • Function Documentation

• Template Function addNdInit
  • Function Documentation

• Function PYBIND11_MODULE
  • Function Documentation

• Function tfc::utils::TFCUtils::_MatPinv
  • Function Documentation

• Function tfc::utils::TFCUtils::criuCheckpoint
  • Function Documentation
    • criuCheckpoint()

• Function tfc::utils::TFCUtils::egrad
  • Function Documentation

• Function tfc::utils::TFCUtils::egradRobust
  • Function Documentation

• Function tfc::utils::TFCUtils::LS(PyTree, Callable, *Any, list, Optional], Literal, Literal, str, bool)
  • Function Documentation

• Function tfc::utils::TFCUtils::LS(PyTree, Callable, *Any, list, Optional], Literal, Literal, str, bool)
  • Function Documentation

• Function tfc::utils::TFCUtils::LS(PyTree, Callable, *Any, list, Optional], Literal, bool, str, bool)
  • Function Documentation

• Function tfc::utils::TFCUtils::NLLS(PyTree, Callable, *Any, list, Optional], Optional, bool]], Optional, PyTree]], float, uint, Literal, Literal, bool, str, str, bool)
  • Function Documentation

• Function tfc::utils::TFCUtils::NLLS(PyTree, Callable, *Any, list, Optional], Optional, bool]], Optional, PyTree]], float, uint, Literal, Literal, bool, str, str, bool)
  • Function Documentation

• Function tfc::utils::TFCUtils::NLLS(PyTree, Callable, *Any, list, Optional], Optional, bool]], Optional, PyTree]], float, uint, Literal, bool, bool, str, str, bool)
  • Function Documentation

• Function tfc::utils::TFCUtils::nlls_id_print
  • Function Documentation
    • nlls_id_print()

• Function tfc::utils::TFCUtils::onesRobust
  • Function Documentation
    • onesRobust()

• Function tfc::utils::TFCUtils::pe
  • Function Documentation

• Function tfc::utils::TFCUtils::pejit
  • Function Documentation

• Function tfc::utils::TFCUtils::ScaledQrLs
  • Function Documentation

• Function tfc::utils::TFCUtils::step
  • Function Documentation

• Function tfc::utils::TFCUtils::zerosRobust
  • Function Documentation
    • zerosRobust()

• Function xlaWrapper
  • Function Documentation

Variables

• Variable tfc::utils::MayaviMakePlot::Color
  • Variable Documentation
    • Color

• Variable tfc::utils::tfc_types::ConstraintOperator
  • Variable Documentation
    • ConstraintOperator

• Variable tfc::utils::tfc_types::ConstraintOperators
  • Variable Documentation
    • ConstraintOperators

• Variable tfc::utils::tfc_types::Exprs
  • Variable Documentation
    • Exprs

• Variable tfc::utils::tfc_types::IntArrayLike
  • Variable Documentation
    • IntArrayLike

• Variable tfc::utils::tfc_types::IntListOrArray
  • Variable Documentation
    • IntListOrArray

• Variable tfc::utils::tfc_types::JaxOrNumpyArray
  • Variable Documentation
    • JaxOrNumpyArray

• Variable tfc::utils::tfc_types::Number
  • Variable Documentation
    • Number

• Variable tfc::utils::tfc_types::NumberListOrArray
  • Variable Documentation
    • NumberListOrArray

• Variable tfc::utils::tfc_types::Path
  • Variable Documentation
    • Path

• Variable tfc::utils::tfc_types::pint
  • Variable Documentation
    • pint

• Variable tfc::utils::tfc_types::StrArrayLike
  • Variable Documentation
    • StrArrayLike

• Variable tfc::utils::tfc_types::TupleOrListOfArray
  • Variable Documentation
    • TupleOrListOfArray

• Variable tfc::utils::tfc_types::TupleOrListOfNumpyArray
  • Variable Documentation
    • TupleOrListOfNumpyArray

• Variable tfc::utils::tfc_types::uint
  • Variable Documentation
    • uint

• Variable tfc::utils::TFCUtils::TFCDictAddable
  • Variable Documentation
    • TFCDictAddable

• Variable tfc::utils::TFCUtils::TFCDictRobustAddable
  • Variable Documentation
    • TFCDictRobustAddable

Defines

• Define _USE_MATH_DEFINES
  • Define Documentation
    • _USE_MATH_DEFINES

• Define BF_H
  • Define Documentation
    • BF_H

Typedefs

• Typedef xlaFnType
  • Typedef Documentation
    • xlaFnType