index

@qbead/bloch-sphere

---

@qbead/bloch-sphere

Namespaces

Namespace	Description
gates	A set of utilities for standard quantum gates (operators)

Classes

Class	Description
AngleIndicators	Display angle indicators for a Bloch vector
BaseComponent	Abstract base class for all components
BlochSphere	A Bloch Sphere Widget
BlochSphereScene	A scene for the Bloch sphere which extends the THREE.Scene class
BlochVector	A class representing a Bloch vector
Complex	A class representing a complex number.
Label	Label component for displaying text in 3D space
Operator	Quantum operators are 2x2 matrices of complex numbers
OperatorDisplay	A display for a quantum operator
OperatorPathDisplay	A display for the path a qbit takes when it is rotated by an operator
PathDisplay	A display for a path on the Bloch sphere
PointsDisplay	A display for points on the Bloch sphere
QubitArrow	A display for just a qubit arrow
QubitDisplay	A display for a qubit state on the Bloch sphere
QubitProjWedge	A wedge which is a quarter of a circle
RegionDisplay	A display for a region on the Bloch sphere
Wedge	Creates a wedge, that is the outline of a quarter of a circle.

Interfaces

Interface	Description
CancellablePromise	-

Type Aliases

Type Alias	Description
AnimationCallback	-
ArcProperties	Properties of a arc on a sphere
BlochSphereOptions	Options for the Bloch Sphere widget
CancelAnimation	-
IntoComplex	A type that can be converted to a Complex number.
RotationInfo	-

Functions

Function	Description
animate	Animation helper function
axisFromQuaternion	Get axis of rotation and angle from a quaternion
formatDegrees	Format an angle given in radians as a string in degrees with a given precision.
formatRadians	Format an angle given in radians as a string in radians with a given precision.
formatVector	Format a vector as a string with a given precision.
getArcBetween	Gets the properties of an great arc between two vectors
getRotationArc	Gets properties of an arc starting from v and rotating about n by angle
lerp	Standard linear interpolation function
lerpAngle	Linear interpolation function that wraps around 2π
shortestModDist	Computes the shortest distance between two angles, considering wrap-around