votca 2026-dev
Loading...
Searching...
No Matches
citations.h File Reference
#include <string>
#include <vector>
Include dependency graph for citations.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  votca::xtp::citations::Reference
struct  votca::xtp::citations::Optional
 a reference that depends on the options of a calculator More...
struct  votca::xtp::citations::CalculatorEntry

Namespaces

namespace  votca
 Provides a means for comparing floating point numbers.
namespace  votca::xtp
 Charge transport classes.
namespace  votca::xtp::citations
 References for the methods used in a run.

Macros

#define VOTCA_XTP_CITATIONS_H

Functions

void votca::xtp::citations::Cite (const std::string &key)
 marks a reference as used (thread safe; unknown keys are printed as such)
std::vector< std::string > votca::xtp::citations::Used ()
 the keys used so far, in the order of first use
void votca::xtp::citations::Reset ()
const std::vector< Reference > & votca::xtp::citations::References ()
 all references
bool votca::xtp::citations::Exists (const std::string &key)
std::string votca::xtp::citations::Format (const std::string &key)
 one line: text and DOI
std::string votca::xtp::citations::Report ()
 the block printed at the end of a run (empty if nothing was cited)
CalculatorEntry votca::xtp::citations::ForCalculator (const std::string &name)
 the references of a calculator or tool (empty for unknown names)
std::vector< std::string > votca::xtp::citations::Calculators ()
 all calculators and tools of the table
std::string votca::xtp::citations::CalculatorReport (const std::string &name)
 the text printed by –cite

Macro Definition Documentation

◆ VOTCA_XTP_CITATIONS_H

#define VOTCA_XTP_CITATIONS_H

Definition at line 22 of file citations.h.