Cadabra
Computer algebra system for field theory problems
Public Member Functions | Private Attributes | List of all members
cadabra::LaTeXForm Class Reference

#include <LaTeXForm.hh>

Inheritance diagram for cadabra::LaTeXForm:
cadabra::property

Public Member Functions

virtual std::string name () const override
 
virtual bool parse (Kernel &, keyval_t &) override
 
virtual std::string unnamed_argument () const override
 
std::string latex_form () const
 Return the LaTeX string which should be used to display the object to which this property is associated. More...
 
- Public Member Functions inherited from cadabra::property
 property (bool hidden=false)
 
virtual ~property ()
 
bool parse_to_keyvals (const Ex &, keyval_t &)
 
virtual bool parse (Kernel &, std::shared_ptr< Ex >, keyval_t &keyvals)
 
virtual void validate (const Kernel &, const Ex &) const
 
virtual void latex (std::ostream &) const
 Display the property on the stream. More...
 
virtual match_t equals (const property *) const
 
void hidden (bool h)
 Properties can be hidden because they only make sense to the system; they will not be printed when the user asks for a list of properties. More...
 
bool hidden (void) const
 

Private Attributes

std::string latex_
 

Additional Inherited Members

- Public Types inherited from cadabra::property
enum  match_t { no_match, id_match, exact_match }
 

Member Function Documentation

◆ latex_form()

std::string LaTeXForm::latex_form ( ) const

Return the LaTeX string which should be used to display the object to which this property is associated.

Will be interpreted by DisplayTeX because it can contain patterns (as e.g. in a{b??}::LaTeXForm("| b?? \rangle")).

◆ name()

std::string LaTeXForm::name ( ) const
overridevirtual

Implements cadabra::property.

◆ parse()

bool LaTeXForm::parse ( Kernel ,
keyval_t keyvals 
)
overridevirtual

Reimplemented from cadabra::property.

◆ unnamed_argument()

std::string LaTeXForm::unnamed_argument ( ) const
overridevirtual

Reimplemented from cadabra::property.

Member Data Documentation

◆ latex_

std::string cadabra::LaTeXForm::latex_
private

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