Functions

Math helper functions for free parameter expressions.

These helpers let you build symbolic OpenQASM math expressions without importing SymPy or touching the internal expression attribute.

Examples

>>> from braket.circuits import Circuit
>>> from braket.parametric import FreeParameter, arcsin
>>> alpha = FreeParameter("alpha")
>>> circuit = Circuit().rx(0, arcsin(alpha))
>>> source = circuit.to_ir("OPENQASM").source
>>> "rx(arcsin(alpha)) q[0];" in source
True

braket.parametric.functions.sin(x)[source]

Returns the sine of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic sine expression.

braket.parametric.functions.cos(x)[source]

Returns the cosine of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic cosine expression.

braket.parametric.functions.tan(x)[source]

Returns the tangent of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic tangent expression.

braket.parametric.functions.arcsin(x)[source]

Returns the arcsine (inverse sine) of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic arcsine expression.

braket.parametric.functions.arccos(x)[source]

Returns the arccosine (inverse cosine) of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic arccosine expression.

braket.parametric.functions.arctan(x)[source]

Returns the arctangent (inverse tangent) of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic arctangent expression.

braket.parametric.functions.exp(x)[source]

Returns the exponential of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic exponential expression.

braket.parametric.functions.log(x)[source]

Returns the natural logarithm of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic natural logarithm expression.

braket.parametric.functions.sqrt(x)[source]

Returns the square root of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic square root expression.

braket.parametric.functions.mod(x, m)[source]

Returns the remainder of a free parameter expression divided by m.

Parameters:

x (FreeParameterExpression | Number) – The dividend expression.
m (FreeParameterExpression | Number) – The divisor expression.

Return type:

FreeParameterExpression

Returns:

FreeParameterExpression – The symbolic modulo expression.

braket.parametric.functions.ceiling(x)[source]

Returns the ceiling of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic ceiling expression.

braket.parametric.functions.floor(x)[source]

Returns the floor of a free parameter expression.

Parameters:: x (FreeParameterExpression | Number) – The expression.
Return type:: FreeParameterExpression
Returns:: FreeParameterExpression – The symbolic floor expression.