Classes
struct	BoolGraph
	A boolean sparse relation over element indices, e.g. More...
struct	Distrib
struct	LqnBalanceEquations
	The relation set of one layered model. More...
struct	LqnBoxBounds
	What lqn_boxbounds returns, in the layout of the reference's out struct. More...
class	LqnBuilder
struct	LqnCallGroup
	One routed call group: an activity, the strategy that picks among its targets, and the target ENTRIES in declaration order. More...
struct	LqnModel
	The intermediate model, and the second stage that flattens it. More...
struct	LqnMolInfo
	Everything lqn_mol reports beyond the four measure vectors. More...
struct	LqnMolOptions
	Tuning of the outer fixed point. More...
struct	LqnMolResult
	The four (nidx+1) vectors in the column convention SolverLN and LQNS report, so they line up with LN(model).getAvgTable cell for cell. More...
struct	LqnPrecedence
	One activity precedence of a task, with its activities resolved to indices. More...
struct	LqnRefCall
	One row of calls: the reference's [cidx, fromPos, toPos, aidx, vCall]. More...
struct	LqnRefGroup
	One group, the reference's R(g): the DAG below one REF task. More...
struct	LqnRefRoutes
	What lqn_ref_routes returns: the groups, or a non-empty why and no groups. More...
struct	LqnRelation
	One conservation law, as an aggregation over a node's structural neighbours. More...
struct	LqnSolution
	The iterates of a solved layered model, indexed by ABSOLUTE element index. More...
struct	LqnStruct
struct	LqnWriteReport
	What the schema could not carry, one human-readable line per loss. More...
struct	ServerPools
	Heterogeneous server pools declared on a layer server, the twin of the nservertypes / servertypenames / serverspertype / servercompat / heterorates block a Network carries in sn.nodeparam{i}. More...
struct	SparseGraph
	A sparse square matrix over element indices, held as a dense vector of rows with an explicit nonzero list per row. More...

Typedefs
template<class T>
using	CdScaling
	A class-dependent scaling map, sn.cdscaling.

Enumerations
enum class	CallType
	Call kinds, with the values of MATLAB CallType. More...
enum class	LqnElement
	LQN element kinds, with the values of MATLAB LayeredNetworkElement. More...
enum class	PrecedenceType
	Activity precedence kinds, with the values of MATLAB ActivityPrecedenceType. More...
enum class	ReplacementStrategy
	Cache replacement policies, with the values of MATLAB ReplacementStrategy. More...
enum class	SchedStrategy
	Scheduling disciplines, with the values of MATLAB SchedStrategy. More...

Functions
template<class T>
LqnBalanceEquations< T >	lqn_balance_equations (const LqnStruct< T > &lqn, const LqnSolution< T > *sol=nullptr)
	Enumerate the conservation laws of the layered model lqn.
template<class T>
LqnBoxBounds< T >	lqn_boxbounds (const LqnStruct< T > &lqn)
	Evaluate the box bounds of lqn.
template<class T>
LqnMolResult< T >	lqn_mol (const LqnStruct< T > &lsn, const LqnMolOptions &options=LqnMolOptions())
	Method of Layers on the SRVN decomposition of a layered queueing network whose entries carry no activity graph.
template<class T>
LqnRefRoutes< T >	lqn_ref_routes (const LqnStruct< T > &lqn, const std::vector< std::size_t > &callers, double maxpaths=32.0, const std::vector< std::size_t > &server_set={})
	Resolve the reference routes into the layer whose callers are CALLERS.
template<class T>
LqnStruct< T >	lqn_finalize (const LqnModel< T > &m)
	Port of @LayeredNetwork/getStruct.m: flatten the model into its struct.
template<class T>
LqnModel< T >	read_lqnx_model (const std::string &path)
template<class T>
LqnStruct< T >	read_lqnx (const std::string &path)
	Read a .lqnx model.
template<class T>
LqnWriteReport	write_lqnx (const LqnModel< T > &m, const std::string &path, const std::string &model_name=std::string("LQN"), bool use_abstract_names=false, std::string *out_text=NULL)
	Write a layered model as a .lqnx document.
template<class T>
std::string	lqnx_to_string (const LqnModel< T > &m, const std::string &model_name=std::string("LQN"), bool use_abstract_names=false)
	The .lqnx document as a STRING, for a caller with no file to write to – the CLI's model-generation mode hands the XML back through its JSON envelope, and a test can compare documents without a temporary directory.

Typedef Documentation

◆ CdScaling

template<class T>

using line::lang::CdScaling

A class-dependent scaling map, sn.cdscaling.

It takes the per-class population vector at one station and returns the per-class rate multipliers, which is the signature pfqn_cdfun consumes; the alias resolves to the same std::function type as pfqn::CdScaling, so a map built here is passed straight through to the api layer.

Definition at line 731 of file lang_types.h.

Enumeration Type Documentation

◆ CallType

enum class line::lang::CallType

strong

Call kinds, with the values of MATLAB CallType.

Definition at line 469 of file lang_types.h.

◆ LqnElement

enum class line::lang::LqnElement

strong

LQN element kinds, with the values of MATLAB LayeredNetworkElement.

Definition at line 466 of file lang_types.h.

◆ PrecedenceType

enum class line::lang::PrecedenceType

strong

Activity precedence kinds, with the values of MATLAB ActivityPrecedenceType.

Definition at line 472 of file lang_types.h.

◆ ReplacementStrategy

enum class line::lang::ReplacementStrategy

strong

Cache replacement policies, with the values of MATLAB ReplacementStrategy.

Definition at line 380 of file lang_types.h.

◆ SchedStrategy

enum class line::lang::SchedStrategy

strong

Scheduling disciplines, with the values of MATLAB SchedStrategy.

Definition at line 181 of file lang_types.h.

Function Documentation

◆ lqn_balance_equations()

template<class T>

LqnBalanceEquations< T > line::lqn::lqn_balance_equations	(	const LqnStruct< T > &	lqn,
		const LqnSolution< T > *	sol = nullptr )

Enumerate the conservation laws of the layered model lqn.

When sol is non-null every relation is also instantiated and its residual reported. On a converged fixed point they vanish to the solver's own tolerance; a residual that does not is either a documented convention difference (see mult against maxmult) or a defect in the solution.

Definition at line 466 of file lqn_balance_equations.h.

Referenced by lqn_balance_equations().

◆ lqn_boxbounds()

template<class T>

LqnBoxBounds< T > line::lqn::lqn_boxbounds ( const LqnStruct< T > & lqn )

Evaluate the box bounds of lqn.

A reference task of infinite multiplicity is treated as one customer, as the reference does: the bound is over a closed chain and an infinite population has no lower bound to report.

Definition at line 130 of file lqn_boxbounds.h.

Referenced by line::ln::SolverLN< T >::box_bounds(), and lqn_boxbounds().

◆ lqn_finalize()

template<class T>

LqnStruct< T > line::lqn::lqn_finalize ( const LqnModel< T > & m )

Port of @LayeredNetwork/getStruct.m: flatten the model into its struct.

Definition at line 444 of file lqn_reader.h.

Referenced by line::lqn::LqnBuilder< T >::build(), line::io::build_lqn_from_json(), line::opt::LineEvaluator::evaluate_layered_sensitivities(), line::io::lqn2java(), line::io::lqn2qn(), lqn_finalize(), read_lqnx(), and write_lqnx().

◆ lqn_mol()

template<class T>

LqnMolResult< T > line::lqn::lqn_mol	(	const LqnStruct< T > &	lsn,
		const LqnMolOptions &	options = LqnMolOptions() )

Method of Layers on the SRVN decomposition of a layered queueing network whose entries carry no activity graph.

Parameters

lsn	LayeredNetworkStruct of an entry-only, closed, synchronous LQN
options	iteration cap, tolerance and under-relaxation factor

Definition at line 209 of file lqn_mol.h.

References line::lqn::LqnMolResult< T >::info, lqn_mol(), line::pfqn::pfqn_qdamva(), line::lqn::LqnMolResult< T >::QN, line::pfqn::QdAmvaResult< T >::R, line::lqn::LqnMolResult< T >::RN, line::lqn::LqnMolResult< T >::TN, and line::lqn::LqnMolResult< T >::UN.

Referenced by lqn_mol().

◆ lqn_ref_routes()

template<class T>

LqnRefRoutes< T > line::lqn::lqn_ref_routes	(	const LqnStruct< T > &	lqn,
		const std::vector< std::size_t > &	callers,
		double	maxpaths = 32.0,
		const std::vector< std::size_t > &	server_set = {} )

Resolve the reference routes into the layer whose callers are CALLERS.

Parameters

lqn	the layered struct (after lqn_fwd_rendezvous, as SolverLN holds it)
callers	task indices that call the layer's server
maxpaths	refuse the layer above this many REF routes into it (default 32)
server_set	server elements of the layer; a prefix node whose task is one of them refuses

A caller reachable from two REF tasks is two INDEPENDENT customer pools, and the whole LAYER falls back rather than that caller alone: a refused caller may lie on another group's path, which would count its threads twice.

Definition at line 384 of file lqn_ref_routes.h.

References lqn_ref_routes().

Referenced by lqn_ref_routes().

◆ lqnx_to_string()

template<class T>

std::string line::lqn::lqnx_to_string	(	const LqnModel< T > &	m,
		const std::string &	model_name = std::string("LQN"),
		bool	use_abstract_names = false )

The .lqnx document as a STRING, for a caller with no file to write to – the CLI's model-generation mode hands the XML back through its JSON envelope, and a test can compare documents without a temporary directory.

Definition at line 550 of file lqn_writer.h.

References lqnx_to_string(), and write_lqnx().

Referenced by lqnx_to_string(), and run_generate().

◆ read_lqnx()

template<class T>

LqnStruct< T > line::lqn::read_lqnx ( const std::string & path )

Read a .lqnx model.

Parameters

path	file to read

Returns: the flattened struct SolverLN consumes

Definition at line 1688 of file lqn_reader.h.

References lqn_finalize(), read_lqnx(), and read_lqnx_model().

Referenced by line::io::read_layered_model(), and read_lqnx().

◆ read_lqnx_model()

template<class T>

LqnModel< T > line::lqn::read_lqnx_model ( const std::string & path )

◆ write_lqnx()

template<class T>

LqnWriteReport line::lqn::write_lqnx	(	const LqnModel< T > &	m,
		const std::string &	path,
		const std::string &	model_name = std::string("LQN"),
		bool	use_abstract_names = false,
		std::string *	out_text = NULL )

Write a layered model as a .lqnx document.

Parameters

m	the intermediate model, from the builder or from read_lqnx_model
path	file to create
model_name	the name attribute of <lqn-model>
use_abstract_names	rename elements P1/T1/E1/A1, as writeXML's third argument does, for a document that is compared rather than read
out_text	when non-null, the document is SERIALIZED INTO IT and no file is written (path is then ignored). The tree cannot be returned instead: xml::Element owns its children through unique_ptr and they hold raw parent back pointers, so a moved tree dangles.

Returns: what the schema could not carry

Definition at line 219 of file lqn_writer.h.

References line::lqn::LqnModel< T >::acts, line::xml::Element::add_child(), line::lqn::LqnWriteReport::dropped, line::lqn::LqnModel< T >::entries, line::lang::GlobalConstants::FineTol, line::InputError::InputError(), lqn_finalize(), line::xml::Element::name, line::lqn::LqnModel< T >::proc_lincon, line::lqn::LqnModel< T >::proc_linconrows, line::lqn::LqnModel< T >::procs, line::lang::sched_to_lqnx(), line::xml::serialize(), line::xml::Element::set_attr(), line::lqn::LqnModel< T >::tasks, line::UnsupportedError::UnsupportedError(), line::xml::write_file(), and write_lqnx().

Referenced by lqnx_to_string(), line::lqns::SolverLQNS< T >::run_analyzer(), line::io::write_lqnx(), and write_lqnx().

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ CdScaling

Enumeration Type Documentation

◆ CallType

◆ LqnElement

◆ PrecedenceType

◆ ReplacementStrategy

◆ SchedStrategy

Function Documentation

◆ lqn_balance_equations()

◆ lqn_boxbounds()

◆ lqn_finalize()

◆ lqn_mol()

◆ lqn_ref_routes()

◆ lqnx_to_string()

◆ read_lqnx()

◆ read_lqnx_model()

◆ write_lqnx()