qasm-ts 2.0.0 → 2.1.0

package/.github/workflows/draft-pdf.yml

@@ -0,0 +1,24 @@
+name: Draft PDF
+on: [push]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper/paper.pdf

package/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+To get started contributing to QASM-TS, please see the open issues for a place to start.
+Alternatively, you are welcome to create any issues which you feel may capture changes, improvements or additions to the package that would be useful. These may be bug reports or enhancement requests. These will be reviewed in a timely manner by a maintainer. If you are able to implement any desired functionality or bug fixes yourself, we also welcome and promise to review any pull requests. Please simply fork the repository and create a branch in your fork with the changes in question. When you create your pull request, make sure to target our repo.
+Thanks!

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/errors.js

@@ -1,4 +1,13 @@
 "use strict";
+/**
+ * Error classes for QASM parsing and validation
+ *
+ * This module provides specific error types for different parsing failures,
+ * enabling precise error handling and debugging. Each error includes contextual
+ * information about where the error occurred in the source code.
+ *
+ * @module Error Handling
+ */
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||

package/dist/lexer.js

@@ -1,10 +1,84 @@
 "use strict";
+/**
+ * Main lexer interface for tokenizing QASM code
+ *
+ * The lexer is responsible for breaking down QASM source code into tokens
+ * that can be consumed by the parser. It supports both OpenQASM 2.0 and 3.0
+ * syntax, with version-specific lexers handling the differences in token types
+ * and syntax rules.
+ *
+ * The specific Lexer implementations can be found at:
+ * - {@link Qasm3Lexer}
+ * - {@link Qasm2Lexer}
+ *
+ * @module Lexing
+ *
+ * @example Token Flow
+ * ```
+ * Source Code → Lexer → Tokens → Parser → AST
+ * "h q[0];"  →  [Id, Id, LSParen, NNInteger, RSParen, Semicolon]
+ * ```
+ *
+ *  * @example Basic lexing workflow
+ * ```typescript
+ * import { lex } from './lexer';
+ *
+ * const qasmCode = 'OPENQASM 3.0; qubit q; h q;';
+ * const tokens = lex(qasmCode);
+ * console.log(tokens);
+ * // [
+ * //   [Token.OpenQASM, undefined],
+ * //   [Token.Id, 'qubit'],
+ * //   [Token.Id, 'q'],
+ * //   [Token.Semicolon, undefined],
+ * //   [Token.Id, 'h'],
+ * //   [Token.Id, 'q'],
+ * //   [Token.Semicolon, undefined]
+ * // ]
+ * ```
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lex = lex;
 var lexer_1 = require("./qasm2/lexer");
 var lexer_2 = require("./qasm3/lexer");
 var version_1 = require("./version");
 var errors_1 = require("./errors");
+/**
+ * Tokenizes OpenQASM source code into an array of tokens.
+ *
+ * This is the main entry point for lexical analysis. It automatically selects
+ * the appropriate lexer implementation based on the OpenQASM version and returns
+ * an array of tokens that can be consumed by the parser.
+ *
+ * Each token is represented as a tuple containing:
+ * - **Token type**: An enum value indicating the kind of token
+ * - **Token value**: The associated value (for literals, identifiers, operators)
+ *
+ * @group Lexing
+ * @param qasm - The OpenQASM source code to tokenize
+ * @param cursor - Starting position in the input string (defaults to 0)
+ * @param version - OpenQASM version to use for lexing (defaults to 3.0)
+ * @returns Array of token tuples [TokenType, value?]
+ * @throws {UnsupportedOpenQASMVersionError} When an unsupported version is specified
+ *
+ * @example Tokenize OpenQASM 3.0 code
+ * ```typescript
+ * const tokens = lex('qubit[2] q; h q[0];', 0, 3);
+ * // Returns tokens using OpenQASM 3.0 syntax rules
+ * ```
+ *
+ * @example Tokenize OpenQASM 2.0 code
+ * ```typescript
+ * const tokens = lex('qreg q[2]; h q[0];', 0, 2);
+ * // Returns tokens using OpenQASM 2.0 syntax rules
+ * ```
+ *
+ * @example Resume lexing from specific position
+ * ```typescript
+ * const code = 'OPENQASM 3.0; qubit q;';
+ * const tokens = lex(code, 12); // Start after "OPENQASM 3.0"
+ * ```
+ */
 function lex(qasm, cursor, version) {
     var lexer;
     if (version instanceof version_1.OpenQASMVersion) {

package/dist/main.js

@@ -3,13 +3,63 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseString = parseString;
 exports.parseFile = parseFile;
+/**
+ * Main parsing functions for qasm-ts - the primary entry points for parsing OpenQASM code
+ * @module Main Functions
+ */
 var fs = require("fs");
 var lexer_1 = require("./lexer");
 var parser_1 = require("./parser");
 /**
- * Returns the abstract syntax tree for a given string of QASM code.
- * @param qasm - The code string.
- * @return The corresponding AST.
+ * Parses OpenQASM code from a string and returns the abstract syntax tree.
+ *
+ * This is the primary entry point for parsing OpenQASM code. It handles both
+ * OpenQASM 2.0 and 3.0 syntax, automatically selecting the appropriate lexer
+ * and parser based on the version parameter.
+ *
+ * @group Main Functions
+ * @param qasm - The OpenQASM code string to parse
+ * @param version - The OpenQASM version to use (defaults to 3.0)
+ * @param verbose - Whether to include class names in the output (defaults to false)
+ * @param stringify - Whether to return stringified JSON (defaults to false)
+ * @returns The corresponding AST as an array of nodes, or stringified JSON if stringify is true
+ *
+ * @example Basic OpenQASM 3.0 parsing
+ * ```typescript
+ * import { parseString } from 'qasm-ts';
+ *
+ * const qasmCode = `
+ * OPENQASM 3.0;
+ * include "stdgates.inc";
+ * qubit[2] q;
+ * h q[0];
+ * cx q[0], q[1];
+ * `;
+ *
+ * const ast = parseString(qasmCode);
+ * console.log(ast);
+ * ```
+ *
+ * @example OpenQASM 2.0 parsing
+ * ```typescript
+ * const qasm2Code = `
+ * OPENQASM 2.0;
+ * include "qelib1.inc";
+ * qreg q[2];
+ * creg c[2];
+ * h q[0];
+ * cx q[0],q[1];
+ * measure q -> c;
+ * `;
+ *
+ * const ast = parseString(qasm2Code, 2);
+ * ```
+ *
+ * @example Verbose output with class names
+ * ```typescript
+ * const ast = parseString(qasmCode, 3, true);
+ * // Output will include __className__ properties for each node
+ * ```
  */
 function parseString(qasm, version, verbose, stringify) {
     var ast;
@@ -29,14 +79,39 @@ function parseString(qasm, version, verbose, stringify) {
     return ast;
 }
 /**
- * Returns the abstract syntax tree for a given QASM file.
- * @param file - The file location.
- * @return The corresponding AST.
+ * Parses OpenQASM code from a file and returns the abstract syntax tree.
+ *
+ * @group Main Functions
+ * @param file - The path to the .qasm file to parse
+ * @param version - The OpenQASM version to use (defaults to 3.0)
+ * @param verbose - Whether to include class names in the output (defaults to false)
+ * @param stringify - Whether to return stringified JSON (defaults to false)
+ * @returns The corresponding AST as an array of nodes, or stringified JSON if stringify is true
+ *
+ * @example Parse a QASM file
+ * ```typescript
+ * import { parseFile } from 'qasm-ts';
+ *
+ * // Parse OpenQASM 3.0 file
+ * const ast = parseFile('./my-circuit.qasm');
+ *
+ * // Parse OpenQASM 2.0 file
+ * const ast2 = parseFile('./legacy-circuit.qasm', 2);
+ * ```
+ *
+ * @example Parse with verbose output
+ * ```typescript
+ * const ast = parseFile('./circuit.qasm', 3, true);
+ * // Includes detailed class information for each AST node
+ * ```
  */
 function parseFile(file, version, verbose, stringify) {
     return parseString(fs.readFileSync(file, "utf8"), version, verbose, stringify);
 }
-/** Adds class names to the ast. */
+/**
+ * Adds class names to AST nodes for detailed inspection.
+ * @internal
+ */
 function getDetailedOutput(object) {
     if (Array.isArray(object)) {
         return object.map(getDetailedOutput);

package/dist/parser.js

@@ -1,10 +1,81 @@
 "use strict";
+/**
+ * Main parser interface for generating AST from tokens
+ *
+ * The parser is responsible for transforming a stream of tokens into an Abstract
+ * Syntax Tree (AST) that represents the structure of the OpenQASM program. It acts
+ * as a dispatcher, selecting the appropriate version-specific parser based on the
+ * OpenQASM version being used.
+ *
+ * The parsing process follows these steps:
+ * 1. Receive tokenized input from the lexer
+ * 2. Determine OpenQASM version (2.0 or 3.0)
+ * 3. Select appropriate parser implementation
+ * 4. Generate version-specific AST nodes
+ *
+ * The specific Parser implementations can be found at:
+ * - {@link Qasm3Parser}
+ * - {@link Qasm2Parser}
+ *
+ * @module Parsing
+ *
+ * @example Basic parsing workflow
+ * ```typescript
+ * import { lex } from './lexer';
+ * import { parse } from './parser';
+ *
+ * const qasmCode = 'OPENQASM 3.0; h q[0];';
+ * const tokens = lex(qasmCode, undefined, 3);
+ * const ast = parse(tokens, 3);
+ * console.log(ast); // Array of AST nodes
+ * ```
+ *
+ * @example Version-specific parsing
+ * ```typescript
+ * // Parse as OpenQASM 2.0
+ * const ast2 = parse(tokens, 2);
+ *
+ * // Parse as OpenQASM 3.0
+ * const ast3 = parse(tokens, 3);
+ *
+ * // Use OpenQASMVersion object
+ * const version = new OpenQASMVersion(3, 0);
+ * const ast = parse(tokens, version);
+ * ```
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parse = parse;
 var parser_1 = require("./qasm2/parser");
 var parser_2 = require("./qasm3/parser");
 var version_1 = require("./version");
 var errors_1 = require("./errors");
+/**
+ * Parses an array of tokens into an Abstract Syntax Tree (AST).
+ *
+ * This is the main entry point for parsing tokenized OpenQASM code. It automatically
+ * selects the appropriate parser implementation based on the specified version and
+ * returns an AST that can be used for further analysis, compilation, or execution.
+ *
+ * @group Parsing
+ * @param tokens - Array of tokens generated by the lexer
+ * @param version - OpenQASM version to use for parsing (defaults to 3.0)
+ * @returns Abstract Syntax Tree representing the parsed program
+ * @throws {UnsupportedOpenQASMVersionError} When an unsupported version is specified
+ *
+ * @example Parse OpenQASM 3.0 tokens
+ * ```typescript
+ * const tokens = lex('OPENQASM 3.0; qubit q; h q;');
+ * const ast = parse(tokens, 3);
+ * // Returns array of OpenQASM 3.0 AST nodes
+ * ```
+ *
+ * @example Parse OpenQASM 2.0 tokens
+ * ```typescript
+ * const tokens = lex('OPENQASM 2.0; qreg q[1]; h q[0];');
+ * const ast = parse(tokens, 2);
+ * // Returns array of OpenQASM 2.0 AST nodes
+ * ```
+ */
 function parse(tokens, version) {
     var parser;
     var castTokens;

package/dist/qasm2/ast.js

@@ -1,4 +1,37 @@
 "use strict";
+/**
+ * OpenQASM 2.0 Abstract Syntax Tree Node Definitions
+ *
+ * This module defines the AST node classes for OpenQASM 2.0, which provides
+ * a simpler and more limited set of constructs compared to OpenQASM 3.0.
+ *
+ * OpenQASM 2.0 focuses on:
+ * - Basic quantum register (`qreg`) and classical register (`creg`) declarations
+ * - Gate definitions and applications
+ * - Measurement operations
+ * - Simple conditional statements
+ * - Basic arithmetic expressions
+ *
+ * Key limitations compared to 3.0:
+ * - No advanced classical types (only registers)
+ * - No control flow structures (loops, complex conditionals)
+ * - No function definitions or subroutines
+ * - Limited expression capabilities
+ *
+ * @module
+ *
+ * @example Basic OpenQASM 2.0 constructs
+ * ```typescript
+ * // Quantum register: qreg q[2];
+ * new QReg('q', 2)
+ *
+ * // Gate application: h q[0];
+ * new ApplyGate('h', [['q', 0]], [])
+ *
+ * // Measurement: measure q[0] -> c[0];
+ * new Measure('q', 'c', 0, 0)
+ * ```
+ */
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||

package/dist/qasm2/lexer.js

@@ -1,4 +1,34 @@
 "use strict";
+/**
+ * OpenQASM 2.0 Lexical Analyzer
+ *
+ * This module implements the lexer for OpenQASM 2.0, which provides a simpler
+ * token set compared to OpenQASM 3.0. The lexer focuses on basic quantum circuit
+ * constructs without the advanced classical programming features of version 3.0.
+ *
+ * Key characteristics of OpenQASM 2.0 lexing:
+ * - **Limited token set**: Basic quantum and classical registers only
+ * - **Simple operators**: Basic arithmetic and comparison operators
+ * - **No control flow**: No tokens for loops, conditionals, or functions
+ * - **Gate-focused**: Emphasis on gate definitions and applications
+ * - **Mathematical functions**: Built-in math functions (sin, cos, etc.)
+ *
+ * Supported constructs:
+ * - Quantum registers (`qreg`) and classical registers (`creg`)
+ * - Gate definitions and applications
+ * - Measurements with arrow notation (`->`)
+ * - Basic arithmetic expressions for gate parameters
+ * - Include statements for library files
+ *
+ * @module
+ *
+ * @example OpenQASM 2.0 lexing
+ * ```typescript
+ * const lexer = new Lexer('qreg q[2]; h q[0]; measure q -> c;');
+ * const tokens = lexer.lex();
+ * // Produces tokens for register declaration, gate, and measurement
+ * ```
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 var token_1 = require("./token");
 var errors_1 = require("../errors");
@@ -68,7 +98,30 @@ function isAlpha(c) {
 function isNewline(c) {
     return /\n|\r(?!\n)|\u2028|\u2029|\r\n/.test(c);
 }
-/** Class representing a lexer. */
+/**
+ * OpenQASM 2.0 Lexical Analyzer
+ *
+ * A simpler lexer implementation focused on the core quantum circuit description
+ * features of OpenQASM 2.0. This lexer handles the essential constructs needed
+ * for basic quantum programming without the complexity of classical programming
+ * language features.
+ *
+ * @example Basic OpenQASM 2.0 tokenization
+ * ```typescript
+ * const source = `
+ *   OPENQASM 2.0;
+ *   include "qelib1.inc";
+ *   qreg q[2];
+ *   creg c[2];
+ *   h q[0];
+ *   cx q[0],q[1];
+ *   measure q -> c;
+ * `;
+ *
+ * const lexer = new Lexer(source);
+ * const tokens = lexer.lex();
+ * ```
+ */
 var Lexer = /** @class */ (function () {
     /**
      * Creates a lexer.