# index

**@qbead/bloch-sphere**

***

## @qbead/bloch-sphere

### Namespaces

| Namespace                                              | Description                                               |
| ------------------------------------------------------ | --------------------------------------------------------- |
| [gates](/bloch-sphere/qbead/namespaces/gates/index.md) | A set of utilities for standard quantum gates (operators) |

### Classes

| Class                                                               | Description                                                           |
| ------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [AngleIndicators](/bloch-sphere/classes/angleindicators.md)         | Display angle indicators for a Bloch vector                           |
| [BaseComponent](/bloch-sphere/classes/basecomponent.md)             | Abstract base class for all components                                |
| [BlochSphere](/bloch-sphere/classes/blochsphere.md)                 | A Bloch Sphere Widget                                                 |
| [BlochSphereScene](/bloch-sphere/classes/blochspherescene.md)       | A scene for the Bloch sphere which extends the THREE.Scene class      |
| [BlochVector](/bloch-sphere/classes/blochvector.md)                 | A class representing a Bloch vector                                   |
| [Complex](/bloch-sphere/classes/complex.md)                         | A class representing a complex number.                                |
| [Label](/bloch-sphere/classes/label.md)                             | Label component for displaying text in 3D space                       |
| [Operator](/bloch-sphere/classes/operator.md)                       | Quantum operators are 2x2 matrices of complex numbers                 |
| [OperatorDisplay](/bloch-sphere/classes/operatordisplay.md)         | A display for a quantum operator                                      |
| [OperatorPathDisplay](/bloch-sphere/classes/operatorpathdisplay.md) | A display for the path a qbit takes when it is rotated by an operator |
| [PathDisplay](/bloch-sphere/classes/pathdisplay.md)                 | A display for a path on the Bloch sphere                              |
| [PointsDisplay](/bloch-sphere/classes/pointsdisplay.md)             | A display for points on the Bloch sphere                              |
| [QubitArrow](/bloch-sphere/classes/qubitarrow.md)                   | A display for just a qubit arrow                                      |
| [QubitDisplay](/bloch-sphere/classes/qubitdisplay.md)               | A display for a qubit state on the Bloch sphere                       |
| [QubitProjWedge](/bloch-sphere/classes/qubitprojwedge.md)           | A wedge which is a quarter of a circle                                |
| [RegionDisplay](/bloch-sphere/classes/regiondisplay.md)             | A display for a region on the Bloch sphere                            |
| [Wedge](/bloch-sphere/classes/wedge.md)                             | Creates a wedge, that is the outline of a quarter of a circle.        |

### Interfaces

| Interface                                                            | Description |
| -------------------------------------------------------------------- | ----------- |
| [CancellablePromise](/bloch-sphere/interfaces/cancellablepromise.md) | -           |

### Type Aliases

| Type Alias                                                             | Description                                       |
| ---------------------------------------------------------------------- | ------------------------------------------------- |
| [AnimationCallback](/bloch-sphere/type-aliases/animationcallback.md)   | -                                                 |
| [ArcProperties](/bloch-sphere/type-aliases/arcproperties.md)           | Properties of a arc on a sphere                   |
| [BlochSphereOptions](/bloch-sphere/type-aliases/blochsphereoptions.md) | Options for the Bloch Sphere widget               |
| [~~CancelAnimation~~](/bloch-sphere/type-aliases/cancelanimation.md)   | -                                                 |
| [IntoComplex](/bloch-sphere/type-aliases/intocomplex.md)               | A type that can be converted to a Complex number. |
| [RotationInfo](/bloch-sphere/type-aliases/rotationinfo.md)             | -                                                 |

### Functions

| Function                                                            | Description                                                                     |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [animate](/bloch-sphere/functions/animate.md)                       | Animation helper function                                                       |
| [axisFromQuaternion](/bloch-sphere/functions/axisfromquaternion.md) | Get axis of rotation and angle from a quaternion                                |
| [formatDegrees](/bloch-sphere/functions/formatdegrees.md)           | Format an angle given in radians as a string in degrees with a given precision. |
| [formatRadians](/bloch-sphere/functions/formatradians.md)           | Format an angle given in radians as a string in radians with a given precision. |
| [formatVector](/bloch-sphere/functions/formatvector.md)             | Format a vector as a string with a given precision.                             |
| [getArcBetween](/bloch-sphere/functions/getarcbetween.md)           | Gets the properties of an great arc between two vectors                         |
| [getRotationArc](/bloch-sphere/functions/getrotationarc.md)         | Gets properties of an arc starting from v and rotating about n by angle         |
| [lerp](/bloch-sphere/functions/lerp.md)                             | Standard linear interpolation function                                          |
| [lerpAngle](/bloch-sphere/functions/lerpangle.md)                   | Linear interpolation function that wraps around 2π                              |
| [shortestModDist](/bloch-sphere/functions/shortestmoddist.md)       | Computes the shortest distance between two angles, considering wrap-around      |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://qbead.gitbook.io/bloch-sphere/index.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.