cirq_google.engine.AbstractLocalProgram

A quantum program designed for local in-memory computation.

Inherits From: AbstractProgram

View aliases

Main aliases

cirq_google.engine.abstract_local_program.AbstractLocalProgram

cirq_google.engine.AbstractLocalProgram(
    circuits: List[cirq.Circuit], engine: 'AbstractLocalEngine'
)

This implements all the methods in AbstractProgram using in-memory objects. Labels, descriptions, and time are all stored using dictionaries.

This is a partially implemented instance. Inheritors will still need to implement abstract methods.

Methods

`add_job`

View source

add_job(
    job_id: str, job: 'AbstractLocalJob'
) -> None

`add_labels`

View source

add_labels(
    labels: Dict[str, str]
) -> 'AbstractProgram'

Adds new labels to a previously created quantum program.

Params
`labels`	New labels to add to the existing program labels.

Returns
This AbstractProgram.

`batch_size`

View source

batch_size() -> int

Returns the number of programs in a batch program.

`create_time`

View source

create_time() -> 'datetime.datetime'

Returns when the program was created.

`delete`

View source

@abc.abstractmethod
delete(
    delete_jobs: bool = False
) -> None

Deletes a previously created quantum program.

Params
`delete_jobs`	If True will delete all the program's jobs, other this will fail if the program contains any jobs.

`delete_job`

View source

@abc.abstractmethod
delete_job(
    job_id: str
) -> None

Removes a child job from this program.

`description`

View source

description() -> str

Returns the description of the program.

`engine`

View source

engine() -> 'AbstractLocalEngine'

Returns the parent Engine object.

Returns
The program's parent Engine.

`get_circuit`

View source

get_circuit(
    program_num: Optional[int] = None
) -> cirq.Circuit

Returns the cirq Circuit for the program. This is only supported if the program was created with the V2 protos.

Args
`program_num`	if this is a batch program, the index of the circuit in the batch. This argument is zero-indexed. Negative values indexing from the end of the list.

Returns
The program's cirq Circuit.

`get_job`

View source

get_job(
    job_id: str
) -> 'AbstractLocalJob'

Returns an AbstractLocalJob for an existing Quantum Engine job.

Args
`job_id`	Unique ID of the job within the parent program.

Returns
A AbstractLocalJob for this program.

Raises
`KeyError`	if job is not found.

`labels`

View source

labels() -> Dict[str, str]

Returns the labels of the program.

`list_jobs`

View source

list_jobs(
    created_before: Optional[Union[datetime.datetime, datetime.date]] = None,
    created_after: Optional[Union[datetime.datetime, datetime.date]] = None,
    has_labels: Optional[Dict[str, str]] = None,
    execution_states: Optional[Set[quantum.ExecutionStatus.State]] = None
) -> Sequence['AbstractLocalJob']

Returns the list of jobs for this program.

Args
`created_after`	retrieve jobs that were created after this date or time.
`created_before`	retrieve jobs that were created before this date or time.
`has_labels`	retrieve jobs that have labels on them specified by this dict. If the value is set to ``, filters having the label regardless of the label value will be filtered. For example, to query programs that have the shape label and have the color label with value red can be queried using {'color': 'red', 'shape':''}
`execution_states`	retrieve jobs that have an execution state that is contained in `execution_states`. See `quantum.ExecutionStatus.State` enum for accepted values.

`remove_labels`

View source

remove_labels(
    keys: List[str]
) -> 'AbstractProgram'

Removes labels with given keys from the labels of a previously created quantum program.

Params
`label_keys`	Label keys to remove from the existing program labels.

Returns
This AbstractProgram.

`set_description`

View source

set_description(
    description: str
) -> 'AbstractProgram'

Sets the description of the program.

Params
`description`	The new description for the program.

Returns
This AbstractProgram.

`set_labels`

View source

set_labels(
    labels: Dict[str, str]
) -> 'AbstractProgram'

Sets (overwriting) the labels for a previously created quantum program.

Params
`labels`	The entire set of new program labels.

Returns
This AbstractProgram.

`update_time`

View source

update_time() -> 'datetime.datetime'

Returns when the program was last updated.