Struct QftFile 

pub struct QftFile { /* private fields */ }

A quantum state file in .qft format

Implementations

impl QftFile

pub async fn load_async(path: impl AsRef<Path>) -> Result<Self>

Available on crate feature async only.

Asynchronously load a QFT file.

pub async fn save_async(&self, path: impl AsRef<Path>) -> Result<()>

Available on crate feature async only.

Asynchronously save a QFT file.

impl QftFile

pub fn new(num_qubits: usize) -> Result<Self>

Create a new QFT file with the specified number of qubits. Initializes to the |0…0⟩ state.

Arguments

• num_qubits - Number of qubits (1-30)

Example

use qft::QftFile;
let state = QftFile::new(4).unwrap();
assert_eq!(state.num_qubits(), 4);
assert_eq!(state.dimension(), 16);

pub fn with_config(num_qubits: usize, config: QftConfig) -> Result<Self>

Create a QFT file with custom configuration.

pub fn from_amplitudes(amplitudes: Vec<Complex64>) -> Result<Self>

Create from a vector of complex amplitudes.

Example

use qft::QftFile;
use num_complex::Complex64;

let sqrt2_inv = 1.0 / 2.0_f64.sqrt();
let amplitudes = vec![
    Complex64::new(sqrt2_inv, 0.0),
    Complex64::new(0.0, 0.0),
    Complex64::new(0.0, 0.0),
    Complex64::new(sqrt2_inv, 0.0),
];
let bell = QftFile::from_amplitudes(amplitudes).unwrap();
assert_eq!(bell.num_qubits(), 2);

pub fn from_real_imag(real: &[f64], imag: &[f64]) -> Result<Self>

Create from separate real and imaginary arrays.

pub fn num_qubits(&self) -> usize

Get the number of qubits.

pub fn dimension(&self) -> usize

Get the state vector dimension (2^num_qubits).

pub fn config(&self) -> &QftConfig

Get the configuration.

pub fn config_mut(&mut self) -> &mut QftConfig

Get mutable reference to configuration.

pub fn amplitudes(&self) -> &[Complex64]

Get all amplitudes as a slice.

pub fn amplitudes_mut(&mut self) -> &mut [Complex64]

Get mutable access to amplitudes.

pub fn get_amplitude(&self, index: usize) -> Result<Complex64>

Get a single amplitude by basis state index.

pub fn set_amplitude(&mut self, index: usize, value: Complex64) -> Result<()>

Set a single amplitude by basis state index.

pub fn set_amplitudes(&mut self, amplitudes: &[Complex64]) -> Result<()>

Set all amplitudes from a slice.

pub fn set_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Set a metadata key-value pair.

pub fn get_metadata(&self, key: &str) -> Option<&str>

Get a metadata value by key.

pub fn metadata(&self) -> &HashMap<String, String>

Get all metadata.

pub fn metadata_mut(&mut self) -> &mut HashMap<String, String>

Get mutable access to metadata.

pub fn norm_squared(&self) -> f64

Calculate the norm squared (sum of |amplitude|²).

pub fn norm(&self) -> f64

Calculate the norm.

pub fn is_normalized(&self, tolerance: f64) -> bool

Check if the state is normalized within tolerance.

pub fn normalize(&mut self) -> Result<()>

Normalize the state vector in place.

pub fn inner_product(&self, other: &QftFile) -> Result<Complex64>

Calculate the inner product ⟨self|other⟩.

pub fn fidelity(&self, other: &QftFile) -> Result<f64>

Calculate the fidelity |⟨self|other⟩|².

pub fn trace_distance(&self, other: &QftFile) -> Result<f64>

Calculate the trace distance to another state.

pub fn load(path: impl AsRef<Path>) -> Result<Self>

Load a QFT file from disk.

Example

use qft::QftFile;
let state = QftFile::load("state.qft").unwrap();

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Save the QFT file to disk.

Example

use qft::QftFile;
let state = QftFile::new(4).unwrap();
state.save("state.qft").unwrap();

pub fn read_from<R: Read>(reader: &mut R) -> Result<Self>

Read from any reader.

pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<()>

Write to any writer.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Serialize to bytes.

pub fn from_bytes(data: &[u8]) -> Result<Self>

Deserialize from bytes.

pub fn to_json(&self) -> Result<String>

Export to JSON.

pub fn from_json(json: &str) -> Result<Self>

Import from JSON.

Trait Implementations

impl Clone for QftFile

fn clone(&self) -> QftFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QftFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for QftFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Index<usize> for QftFile

type Output = Complex<f64>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for QftFile

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a QftFile

type Item = &'a Complex<f64>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Complex<f64>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for QftFile

type Item = Complex<f64>

The type of the elements being iterated over.

type IntoIter = IntoIter<Complex<f64>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.