Scalar

Literal

Bases: Real

value instance-attribute

value: Decimal

Scalar Literal, which stores a decimaal value instance.

Parameters:

Name	Type	Description	Default
value	Decimal	decimal value instance	required

Scalar

Base class for all scalar expressions.

<scalar> ::= <literal>
| <variable>
| <default>
| <negative>
| <add>
| <mul>
| <min>
| <max>
| <slice>
| <inverval>

<mul> ::= <scalar> '*' <scalar>
<add> ::= <scalar> '+' <scalar>
<min> ::= 'min' <scalar>+
<max> ::= 'max' <scalar>+
<slice> ::= <scalar expr> '[' <interval> ']'
<interval> ::= <scalar expr> '..' <scalar expr>
<real> ::= <literal> | <var>

Variable

Bases: Real

Variable, which stores a variable name.

Parameters:

Name	Type	Description	Default
name	str	variable instance.	required

cast

cast(py) -> Scalar

1. cast Real number (or list/tuple of Real numbers) to [Scalar Literal][bloqade.ir.scalar.Literal].

2. cast str (or list/tuple of Real numbers) to [Scalar Variable][bloqade.ir.scalar.Variable].

Parameters:

Name	Type	Description	Default
py	Union[str, Real, Tuple[Real], List[Real]]	python object to cast	required

Returns:

Type	Description
Scalar	Scalar

Source code in .venv/lib/python3.12/site-packages/bloqade/analog/ir/scalar.py

def cast(py) -> "Scalar":
    """
    1. cast Real number (or list/tuple of Real numbers)
    to [`Scalar Literal`][bloqade.ir.scalar.Literal].

    2. cast str (or list/tuple of Real numbers)
    to [`Scalar Variable`][bloqade.ir.scalar.Variable].

    Args:
        py (Union[str,Real,Tuple[Real],List[Real]]): python object to cast

    Returns:
        Scalar
    """
    ret = trycast(py)
    if ret is None:
        raise TypeError(f"Cannot cast {type(py)} to Scalar Literal")

    return ret

var

var(py: str) -> Variable

cast string (or list/tuple of strings) to [Variable][bloqade.ir.scalar.Variable].

Parameters:

Name	Type	Description	Default
py	Union[str, List[str]]	a string or list/tuple of strings	required

Returns:

Type	Description
Variable	Union[Variable]

Source code in .venv/lib/python3.12/site-packages/bloqade/analog/ir/scalar.py

def var(py: str) -> "Variable":
    """cast string (or list/tuple of strings)
    to [`Variable`][bloqade.ir.scalar.Variable].

    Args:
        py (Union[str, List[str]]): a string or list/tuple of strings

    Returns:
       Union[Variable]
    """
    ret = tryvar(py)
    if ret is None:
        raise TypeError(f"Cannot cast {type(py)} to Variable")

    return ret