Description

Class to handle display of expressions using LaTeX notation.

This is a very non-local bit of logic, in the sense that it will try to look around the property assignments in order to figure out the best way to print any given object. See the DisplayTeX::dispatch method to see how this works in more detail.

#include <DisplayTeX.hh>

Inheritance diagram for cadabra::DisplayTeX:

Public Member Functions
	DisplayTeX (const Kernel &, const Ex &)

Public Member Functions inherited from cadabra::DisplayBase
	DisplayBase (const Kernel &, const Ex &)

void	output (std::ostream &)

void	output (std::ostream &, Ex::iterator)

Protected Member Functions
virtual bool	needs_brackets (Ex::iterator it) override
	Determine if a node needs extra brackets around it. More...

Private Member Functions
void	print_multiplier (std::ostream &, Ex::iterator, int mult=1)

void	print_opening_bracket (std::ostream &, str_node::bracket_t, str_node::parent_rel_t)

void	print_closing_bracket (std::ostream &, str_node::bracket_t, str_node::parent_rel_t)

void	print_parent_rel (std::ostream &, str_node::parent_rel_t, bool first)

void	print_children (std::ostream &, Ex::iterator, int skip=0)

std::string	texify (std::string) const

virtual void	dispatch (std::ostream &, Ex::iterator) override
	For every object encountered, dispatch will figure out the most appropriate way to convert it into a LaTeX expression. More...

void	print_productlike (std::ostream &, Ex::iterator, const std::string &inbetween)
	Printing members for various standard constructions, e.g. More...

void	print_sumlike (std::ostream &, Ex::iterator)

void	print_fraclike (std::ostream &, Ex::iterator)

void	print_commalike (std::ostream &, Ex::iterator)

void	print_arrowlike (std::ostream &, Ex::iterator)

void	print_powlike (std::ostream &, Ex::iterator)

void	print_intlike (std::ostream &, Ex::iterator)

void	print_equalitylike (std::ostream &, Ex::iterator)

void	print_commutator (std::ostream &str, Ex::iterator it, bool comm)

void	print_components (std::ostream &, Ex::iterator)

void	print_conditional (std::ostream &, Ex::iterator)

void	print_relation (std::ostream &, Ex::iterator)

void	print_indexbracket (std::ostream &, Ex::iterator)

void	print_wedgeproduct (std::ostream &, Ex::iterator)

void	print_tableau (std::ostream &, Ex::iterator)

void	print_ftableau (std::ostream &, Ex::iterator)

void	print_other (std::ostream &str, Ex::iterator it)

bool	children_have_brackets (Ex::iterator ch) const

bool	reads_as_operator (Ex::iterator obj, Ex::iterator arg) const
	Determine whether the indicated object 'obj', when acting on the single argument 'arg', reads as an operator, and therefore 'arg' does not need to be wrapped in brackets. More...

Private Attributes
bool	print_star =false

bool	tight_star =false

bool	tight_plus =false

bool	utf8_output =false

bool	latex_spacing =true

bool	latex_linefeeds =true

bool	extra_brackets_for_symbols =false

int	bracket_level =0

std::map< std::string, std::string >	symmap
	Map from Cadabra symbols to LaTeX symbols (for some typographic cleanup). More...

std::set< std::string >	curly_bracket_operators
	List of operators which need all arguments fed with curly brackets, not round ones (e.g. More...

Additional Inherited Members
Protected Attributes inherited from cadabra::DisplayBase
const Ex &	tree

const Kernel &	kernel

Constructor & Destructor Documentation

DisplayTeX::DisplayTeX	(	const Kernel &	k,
		const Ex &	e
	)

Member Function Documentation

bool DisplayTeX::children_have_brackets ( Ex::iterator ch ) const

private

void DisplayTeX::dispatch	(	std::ostream &	str,
		Ex::iterator	it
	)

overrideprivatevirtual

For every object encountered, dispatch will figure out the most appropriate way to convert it into a LaTeX expression.

This may be done by simply looking at the object's name (e.g. will print as a product) but may also involve looking up properties and deciding on the best course of action based on the attached properties.

Implements cadabra::DisplayBase.

bool DisplayTeX::needs_brackets ( Ex::iterator it )

overrideprotectedvirtual

Determine if a node needs extra brackets around it.

Uses context from the parent node if necessary. Has to be implemented in a derived class, because the answer depends on the printing method (e.g. (a+b)/c needs brackets when printed like this, but does not need brackets when printed as {a+b}{c}).

Implements cadabra::DisplayBase.

void DisplayTeX::print_arrowlike	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_children	(	std::ostream &	str,
		Ex::iterator	it,
		int	skip = `0`
	)

private

void DisplayTeX::print_closing_bracket	(	std::ostream &	str,
		str_node::bracket_t	br,
		str_node::parent_rel_t	pr
	)

private

void DisplayTeX::print_commalike	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_commutator	(	std::ostream &	str,
		Ex::iterator	it,
		bool	comm
	)

private

void DisplayTeX::print_components	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_conditional	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_equalitylike	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_fraclike	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_ftableau	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_indexbracket	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_intlike	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_multiplier	(	std::ostream &	str,
		Ex::iterator	it,
		int	mult = `1`
	)

private

void DisplayTeX::print_opening_bracket	(	std::ostream &	str,
		str_node::bracket_t	br,
		str_node::parent_rel_t	pr
	)

private

void DisplayTeX::print_other	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_parent_rel	(	std::ostream &	str,
		str_node::parent_rel_t	pr,
		bool	first
	)

private

void DisplayTeX::print_powlike	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_productlike	(	std::ostream &	str,
		Ex::iterator	it,
		const std::string &	inbetween
	)

private

Printing members for various standard constructions, e.g.

print as a list, or as a decorated symbol with super/subscripts etc. The names reflect the structure of the output, not necessarily the meaning or name of the object that is being printed.

void DisplayTeX::print_relation	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_sumlike	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_tableau	(	std::ostream &	str,
		Ex::iterator	it
	)

private

void DisplayTeX::print_wedgeproduct	(	std::ostream &	str,
		Ex::iterator	it
	)

private

bool DisplayTeX::reads_as_operator	(	Ex::iterator	obj,
		Ex::iterator	arg
	)		const

private

Determine whether the indicated object 'obj', when acting on the single argument 'arg', reads as an operator, and therefore 'arg' does not need to be wrapped in brackets.

Example: the tree \partial{A} can be displayed as '\partial A' (or rather, '\partial{A}', instead of '\partial(A)'.

std::string DisplayTeX::texify ( std::string str ) const

private

Member Data Documentation

int cadabra::DisplayTeX::bracket_level =0

private

std::set<std::string> cadabra::DisplayTeX::curly_bracket_operators

private

List of operators which need all arguments fed with curly brackets, not round ones (e.g.

\sqrt).

bool cadabra::DisplayTeX::extra_brackets_for_symbols =false

private

bool cadabra::DisplayTeX::latex_linefeeds =true

private

bool cadabra::DisplayTeX::latex_spacing =true

private

bool cadabra::DisplayTeX::print_star =false

private

std::map<std::string, std::string> cadabra::DisplayTeX::symmap

private

Map from Cadabra symbols to LaTeX symbols (for some typographic cleanup).

bool cadabra::DisplayTeX::tight_plus =false

private

bool cadabra::DisplayTeX::tight_star =false

private

bool cadabra::DisplayTeX::utf8_output =false

private

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

core/DisplayTeX.hh
core/DisplayTeX.cc

Description

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation