cirq.protocols.SupportsActOn

An object that explicitly specifies how to act on simulator states.

Methods

_act_on_

View source

Applies an action to the given argument, if it is a supported type.

For example, unitary operations can implement an _act_on_ method that checks if isinstance(args, cirq.ActOnStateVectorArgs) and, if so, apply their unitary effect to the state vector.

The global cirq.act_on method looks for whether or not the given argument has this value, before attempting any fallback strategies specified by the argument being acted on.

This should only be implemented on Operation subclasses. Others such as gates should use SupportsActOnQubits.

Args
args An object of unspecified type. The method must check if this object is of a recognized type and act on it if so.

Returns
True The receiving object (self) acted on the argument.
NotImplemented The receiving object did not act on the argument.

All other return values are considered to be errors.