libqasm
library for handling cQASM files
Namespaces | Functions
cqasm::v1 Namespace Reference

Detailed Description

Namespace for the "new" cQASM 1.x API.

Its contents are pulled into the main cQASM namespace when you include "cqasm.hpp" for compatibility.

Namespaces

 analyzer
 Namespace for the Analyzer class and support classes.
 
 ast
 Namespace for the abstract syntax tree node classes.
 
 error_model
 Namespace for the ErrorModel class and helper types.
 
 functions
 Namespace for the functions generated by func-gen.
 
 instruction
 Namespace for the Instruction class and helper types.
 
 parser
 Namespace for the parser functions and classes.
 
 primitives
 Namespace for the primitive types used in trees generated by tree-gen.
 
 resolver
 Namespace for everything to do with name and overload resolution in cQASM.
 
 semantic
 Namespace for the semantic tree node classes.
 
 types
 Namespace for the classes representing the types available within cQASM.
 
 values
 Namespace for the classes representing the values (including dynamically evaluated expressions or references to registers) available within cQASM.
 

Functions

tree::One< semantic::Programanalyze (const std::string &filename, const std::string &api_version)
 Parses and analyzes the given file with the default analyzer, dumping error messages to stderr and throwing an analyzer::AnalysisFailed on failure. More...
 
tree::One< semantic::Programanalyze (FILE *file, const std::string &filename, const std::string &api_version)
 Parses and analyzes the given file pointer with the default analyzer, dumping error messages to stderr and throwing an analyzer::AnalysisFailed on failure. More...
 
tree::One< semantic::Programanalyze_string (const std::string &data, const std::string &filename, const std::string &api_version)
 Parses and analyzes the given string with the default analyzer, dumping error messages to stderr and throwing an analyzer::AnalysisFailed on failure. More...
 
analyzer::Analyzer default_analyzer (const std::string &api_version)
 Constructs an Analyzer object with the defaults for cQASM 1.0 already loaded into it. More...
 

Function Documentation

◆ analyze() [1/2]

tree::One< semantic::Program > cqasm::v1::analyze ( const std::string &  filename,
const std::string &  api_version 
)

Parses and analyzes the given file with the default analyzer, dumping error messages to stderr and throwing an analyzer::AnalysisFailed on failure.

Definition at line 18 of file cqasm-v1.cpp.

◆ analyze() [2/2]

tree::One< semantic::Program > cqasm::v1::analyze ( FILE *  file,
const std::string &  filename,
const std::string &  api_version 
)

Parses and analyzes the given file pointer with the default analyzer, dumping error messages to stderr and throwing an analyzer::AnalysisFailed on failure.

The optional filename is only used for error messages.

Definition at line 30 of file cqasm-v1.cpp.

◆ analyze_string()

tree::One< semantic::Program > cqasm::v1::analyze_string ( const std::string &  data,
const std::string &  filename,
const std::string &  api_version 
)

Parses and analyzes the given string with the default analyzer, dumping error messages to stderr and throwing an analyzer::AnalysisFailed on failure.

The optional filename is only used for error messages.

Definition at line 43 of file cqasm-v1.cpp.

◆ default_analyzer()

analyzer::Analyzer cqasm::v1::default_analyzer ( const std::string &  api_version)

Constructs an Analyzer object with the defaults for cQASM 1.0 already loaded into it.

Definition at line 55 of file cqasm-v1.cpp.