qp.BoseSentence

class BoseSentence(operator)[source]

Bases: dict

Dictionary used to represent a Bose sentence, a linear combination of Bose words, with the keys as BoseWord instances and the values correspond to coefficients.

>>> w1 = qp.BoseWord({(0, 0) : '+', (1, 1) : '-'})
>>> w2 = qp.BoseWord({(0, 1) : '+', (1, 2) : '-'})
>>> s = qp.BoseSentence({w1 : 1.2, w2: 3.1})
>>> print(s)
1.2 * b⁺(0) b(1)
+ 3.1 * b⁺(1) b(2)

wires

Return wires of the BoseSentence.

wires

Return wires of the BoseSentence.

adjoint()

Return the adjoint of BoseSentence.

clear()

copy()

fromkeys(iterable[, value])

Create a new dictionary with keys from iterable and values set to value.

get(key[, default])

Return the value for key if key is in the dictionary, else default.

items()

keys()

normal_order()

Convert a BoseSentence to its normal-ordered form.

pop(k[,d])

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

prune([tol])

Remove any BoseWords in the BoseSentence with coefficients less than the threshold tolerance.

setdefault(key[, default])

Insert key with a value of default if key is not in the dictionary.

simplify([tol])

Remove any BoseWords in the BoseSentence with coefficients less than the threshold tolerance.

update([E, ]**F)

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

adjoint()[source]

Return the adjoint of BoseSentence.

clear() → None.  Remove all items from D.
copy() → a shallow copy of D
classmethod fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
normal_order()[source]

Convert a BoseSentence to its normal-ordered form.

>>> bw = qp.BoseWord({(0, 0): "-", (1, 0): "-", (2, 0): "+", (3, 0): "+"})
>>> bs = qp.BoseSentence({bw: 1})
>>> print(bs.normal_order())
2.0 * I
+ 4.0 * b⁺(0) b(0)
+ 1.0 * b⁺(0) b⁺(0) b(0) b(0)
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

prune(tol=1e-08)[source]

Remove any BoseWords in the BoseSentence with coefficients less than the threshold tolerance.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

simplify(tol=1e-08)[source]

Remove any BoseWords in the BoseSentence with coefficients less than the threshold tolerance.

This method mutates the BoseSentence in place, and does not return anything.

Warning

The simplify method is deprecated and will be removed in v0.47. Please use the prune() method instead.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values