Internal Documentation#
qlbm is made up of 4 main modules.
Together, the Base Classes, Collisionless Circuits, and Space-Time Circuits
module handle the parameterized creation of quantum circuits that compose QBMs.
The Lattices and Geometry module parses external information into quantum
registers and provides uniform interfaces for underlying algorithms.
The Infrastructure module integrates the quantum components
with Tket, Qiskit, and Qulacs transpilers and runners.
The Other Tools module contains miscellaneous utilities.
- Base Classes
- Lattice Base
LatticeLattice.num_dimsLattice.num_gridpointsLattice.num_velocitiesLattice.num_grid_qubitsLattice.num_velocity_qubitsLattice.num_ancilla_qubitsLattice.num_total_qubitsLattice.velocity_registerLattice.circuitLattice.shapesLattice.registerLattice.discretizationLattice.loggerLattice.parse_input_data()Lattice.parse_geometry_dict()Lattice.to_json()Lattice.get_registers()Lattice.logger_name()Lattice.has_multiple_geometries()
Shape
- Components Base
- Lattice Base
- Collisionless Circuits
- Collision Logic Classes
- Space-Time Circuits
- LQLGA Circuits
- Lattices and Geometry
- Lattices
CollisionlessLatticeCollisionlessLattice.loggerCollisionlessLattice.num_dimsCollisionlessLattice.num_gridpointsCollisionlessLattice.num_velocitiesCollisionlessLattice.num_total_qubitsCollisionlessLattice.ancillae_velocity_index()CollisionlessLattice.ancillae_obstacle_index()CollisionlessLattice.ancillae_comparator_index()CollisionlessLattice.grid_index()CollisionlessLattice.velocity_index()CollisionlessLattice.velocity_dir_index()CollisionlessLattice.get_registers()CollisionlessLattice.logger_name()CollisionlessLattice.has_multiple_geometries()
SpaceTimeLatticeSpaceTimeLattice.grid_index()SpaceTimeLattice.velocity_index()SpaceTimeLattice.ancilla_mass_index()SpaceTimeLattice.ancilla_comparator_index()SpaceTimeLattice.volumetric_ancilla_qubit_combinations()SpaceTimeLattice.get_registers()SpaceTimeLattice.is_inside_an_obstacle()SpaceTimeLattice.logger_name()SpaceTimeLattice.comparator_periodic_volume_bounds()SpaceTimeLattice.has_multiple_geometries()
- Geometry
BlockBlock.get_spacetime_reflection_data_d1q2()Block.get_spacetime_reflection_data_d2q4()Block.get_d2q4_volumetric_reflection_data()Block.get_d2q4_surfaces()Block.get_lqlga_reflection_data_d1q2()Block.get_lqlga_reflection_data_d1q3()Block.contains_gridpoint()Block.stl_mesh()Block.to_json()Block.name()Block.to_dict()
CircleCircle.get_circle_perimeter()Circle.stl_mesh()Circle.is_point_on_segment()Circle.is_point_on_any_segment()Circle.split_perimeter_points()Circle.to_json()Circle.name()Circle.to_dict()Circle.contains_gridpoint()Circle.get_spacetime_reflection_data_d1q2()Circle.get_spacetime_reflection_data_d2q4()Circle.get_d2q4_volumetric_reflection_data()Circle.expand_axis_segments()Circle.expand_diagonal_segments()
DimensionalReflectionDataReflectionPointReflectionWallReflectionResetEdgeSpaceTimePWReflectionDataSpaceTimeVolumetricReflectionDataSpaceTimeDiagonalReflectionData
- Lattices
- Infrastructure
- Other Tools