Library API¶
Welcome to the developer reference to Exhale Companion. The code being documented here is largely meaningless and was only created to test various corner cases e.g. nested namespaces and the like.
Note
The text you are currently reading was fed to exhale_args
using
the afterTitleDescription
key. Full
reStructuredText syntax can be used.
Tip
Sphinx / Exhale support unicode! You’re conf.py
already has
it’s encoding declared as # -*- coding: utf-8 -*-
by
default. If you want to pass Unicode strings into Exhale, simply
prefix them with a u
e.g. u"👽😱💥"
(of course you would
actually do this because you are writing with åçćëñtß or
non-English 寫作 😉).
Page Hierarchy¶
Class Hierarchy¶
-
- Namespace fun
- Template Struct Fraction
- Namespace py
- Template Struct key_iterator
- Template Class dict
- Template Class set
- Namespace xn
- Struct AmbiguousSolution
- Struct ExceededMaxIterations
- Struct HasACycle
- Struct NodeNotFound
- Struct object
- Struct XNetworkAlgorithmError
- Struct XNetworkError
- Struct XNetworkException
- Struct XNetworkNoCycle
- Struct XNetworkNoPath
- Struct XNetworkNotImplemented
- Struct XNetworkPointlessConcept
- Struct XNetworkUnbounded
- Struct XNetworkUnfeasible
- Template Class AtlasView
- Template Class DiGraphS
- Template Class EdgeView
- Template Class grAdaptor
- Template Class Graph
- Template Class NodeView
- Template Class VertexView
- Struct CInfo
- Template Struct Info4EM
- Struct micp1
- Struct Options
- Template Class AdjacencyView
- Template Class AtlasView
- Template Class bsearch_adaptor
- Template Class cycle_ratio_oracle
- Class ell
- Class ell1d
- Class ell_stable
- Class ellipsoid
- Template Class gp_base
- Class ldlt_ext
- Class lmi0_oracle
- Class lmi_old_oracle
- Class lmi_oracle
- Class lowpass_oracle
- Template Class monomial
- Template Class negCycleFinder
- Template Class network_oracle
- Template Class optscaling_oracle
- Class optscaling_oracle::Ratio
- Template Class posynomial
- Template Class profit_max
- Class profit_oracle
- Class profit_q_oracle
- Class profit_rb_oracle
- Class qmi_oracle
- Enum CUTStatus
- Enum CUTSTATUS
- Enum STATUS
- Namespace fun
File Hierarchy¶
-
- Directory ellcpp
- Directory oracles
- File cycle_ratio_oracle.hpp
- File ldlt_ext.hpp
- File lmi0_oracle.hpp
- File lmi_old_oracle.hpp
- File lmi_oracle.hpp
- File lowpass_oracle.hpp
- File network_oracle.hpp
- File optscaling_oracle.hpp
- File profit_oracle.hpp
- File qmi_oracle.hpp
- File cut_config.hpp
- File cutting_plane.hpp
- File ell.hpp
- File ell1d.hpp
- File ell_assert.hpp
- File ell_stable.hpp
- File half_nonnegative.hpp
- File utility.hpp
- Directory oracles
- Directory ellip
- File ellipsoid.cpp
- File ellipsoid.hpp
- File gp_solve.cpp
- File gp_solve.hpp
- File micp_test1.cpp
- File monomial.hpp
- File posynomial.hpp
- File profitmaxprob.cpp
- File profitmaxprob.hpp
- File profitmaxprob_2.cpp
- File rgp_yalaa.cpp
- Directory netoptim
- File min_cycle_ratio.hpp
- File neg_cycle.hpp
- File parametric.hpp
- Directory py2cpp
- File fractions-new.hpp
- File fractions.hpp
- File nx2bgl.hpp
- File py2cpp.hpp
- Directory xnetwork
- Directory classes
- File coreviews.hpp
- File digraphs.hpp
- File graph.hpp
- File reportviews.hpp
- File exception.hpp
- Directory classes
- Directory ellcpp
Below the hierarchies comes the full API listing.
The text you are currently reading is provided by
afterHierarchyDescription
.The Title of the next section just below this normally defaults to
Full API
, but the title was changed by providing an argument tofullApiSubSectionTitle
.You can control the number of bullet points for each linked item on the remainder of the page using
fullToctreeMaxDepth
.
Custom Full API SubSection Title¶
Namespaces¶
Classes and Structs¶
Enums¶
Functions¶
Variables¶
Defines¶
Typedefs¶
You read all the way to the bottom?! This text is specified by giving
an argument to afterBodySummary
. As the docs
state, this summary gets put in after a lot of information. It’s
available for you to use if you want it, but from a design perspective
it’s rather unlikely any of your users will even see this text.