def __init__(self,
*subtemplates: Union[PulseTemplate, MappingTuple],
external_parameters: Optional[Union[Iterable[str], Set[str]]]=None,
identifier: Optional[str]=None,
parameter_constraints: Optional[List[Union[str, Expression]]]=None,
measurements: Optional[List[MeasurementDeclaration]]=None) -> None:
"""Create a new SequencePulseTemplate instance.
Requires a (correctly ordered) list of subtemplates in the form
(PulseTemplate, Dict(str -> str)) where the dictionary is a mapping between the external
parameters exposed by this SequencePulseTemplate to the parameters declared by the
subtemplates, specifying how the latter are derived from the former, i.e., the mapping is
subtemplate_parameter_name -> mapping_expression (as str) where the free variables in the
mapping_expression are parameters declared by this SequencePulseTemplate.
The following requirements must be satisfied:
- for each parameter declared by a subtemplate, a mapping expression must be provided
- each free variable in a mapping expression must be declared as an external parameter
of this SequencePulseTemplate
Args:
subtemplates (List(Subtemplate)): The list of subtemplates of this
SequencePulseTemplate as tuples of the form (PulseTemplate, Dict(str -> str)).
external_parameters (List(str)): A set of names for external parameters of this
SequencePulseTemplate.
identifier (str): A unique identifier for use in serialization. (optional)
Raises:
MissingMappingException, if a parameter of a subtemplate is not mapped to the external
parameters of this SequencePulseTemplate.
MissingParameterDeclarationException, if a parameter mapping requires a parameter
that was not declared in the external parameters of this SequencePulseTemplate.
"""
PulseTemplate.__init__(self, identifier=identifier)
ParameterConstrainer.__init__(self, parameter_constraints=parameter_constraints)
MeasurementDefiner.__init__(self, measurements=measurements)
self.__subtemplates = [MappingPulseTemplate.from_tuple(st) if isinstance(st, tuple) else st
for st in subtemplates]
# check that all subtemplates live on the same channels
defined_channels = self.__subtemplates[0].defined_channels
for subtemplate in self.__subtemplates[1:]:
if subtemplate.defined_channels != defined_channels:
raise ValueError('The subtemplates are defined for different channels')
if external_parameters:
external_parameters = set(external_parameters)
remaining = external_parameters.copy()
for subtemplate in self.__subtemplates:
missing = subtemplate.parameter_names - external_parameters
if missing:
raise MissingParameterDeclarationException(subtemplate, missing.pop())
remaining -= subtemplate.parameter_names
if not external_parameters >= self.constrained_parameters:
raise MissingParameterDeclarationException(self,
(self.constrained_parameters-external_parameters).pop())
remaining -= self.constrained_parameters
if remaining:
raise MissingMappingException(self, remaining.pop())
def test_mapping_permutations(template: DummyPulseTemplate, pmap, mmap,
cmap):
direct = MappingPulseTemplate(template,
parameter_mapping=pmap,
measurement_mapping=mmap,
channel_mapping=cmap)
mappings = [m for m in [pmap, mmap, cmap] if m is not None]
for current_mapping_order in itertools.permutations(mappings):
mapper = MappingPulseTemplate.from_tuple(
(template, *current_mapping_order))
self.assertEqual(mapper.measurement_mapping,
direct.measurement_mapping)
self.assertEqual(mapper.channel_mapping,
direct.channel_mapping)
self.assertEqual(mapper.parameter_mapping,
direct.parameter_mapping)
def test_from_tuple_exceptions(self):
template = DummyPulseTemplate(parameter_names={'foo', 'bar'},
measurement_names={'foo', 'foobar'},
defined_channels={'bar', 'foobar'})
with self.assertRaises(ValueError):
MappingPulseTemplate.from_tuple((template, {'A': 'B'}))
with self.assertRaises(AmbiguousMappingException):
MappingPulseTemplate.from_tuple((template, {'foo': 'foo'}))
with self.assertRaises(AmbiguousMappingException):
MappingPulseTemplate.from_tuple((template, {'bar': 'bar'}))
with self.assertRaises(AmbiguousMappingException):
MappingPulseTemplate.from_tuple((template, {'foobar': 'foobar'}))
template = DummyPulseTemplate(parameter_names={'foo', 'bar'})
with self.assertRaises(MappingCollisionException):
MappingPulseTemplate.from_tuple((template, {
'foo': '1',
'bar': 2
}, {
'foo': '1',
'bar': 4
}))
template = DummyPulseTemplate(defined_channels={'A'})
with self.assertRaises(MappingCollisionException):
MappingPulseTemplate.from_tuple((template, {'A': 'N'}, {'A': 'C'}))
template = DummyPulseTemplate(measurement_names={'M'})
with self.assertRaises(MappingCollisionException):
MappingPulseTemplate.from_tuple((template, {'M': 'N'}, {'M': 'N'}))
def __init__(
self,
*subtemplates: Union[AtomicPulseTemplate, MappingTuple,
MappingPulseTemplate],
external_parameters: Optional[Set[str]] = None,
identifier: Optional[str] = None,
parameter_constraints: Optional[List] = None,
measurements: Optional[List[MeasurementDeclaration]] = None
) -> None:
AtomicPulseTemplate.__init__(self,
identifier=identifier,
measurements=measurements)
ParameterConstrainer.__init__(
self, parameter_constraints=parameter_constraints)
self._subtemplates = [
st if isinstance(st, PulseTemplate) else
MappingPulseTemplate.from_tuple(st) for st in subtemplates
]
for subtemplate in self._subtemplates:
if isinstance(subtemplate, AtomicPulseTemplate):
continue
elif isinstance(subtemplate, MappingPulseTemplate):
if isinstance(subtemplate.template, AtomicPulseTemplate):
continue
else:
raise TypeError(
'Non atomic subtemplate of MappingPulseTemplate: {}'.
format(subtemplate.template))
else:
raise TypeError(
'Non atomic subtemplate: {}'.format(subtemplate))
if not self._subtemplates:
raise ValueError('Cannot create empty MultiChannelPulseTemplate')
defined_channels = [st.defined_channels for st in self._subtemplates]
# check there are no intersections between channels
for i, channels_i in enumerate(defined_channels):
for j, channels_j in enumerate(defined_channels[i + 1:]):
if channels_i & channels_j:
raise ChannelMappingException(
'subtemplate {}'.format(i + 1),
'subtemplate {}'.format(i + 2 + j),
(channels_i | channels_j).pop())
if external_parameters is not None:
remaining = external_parameters.copy()
for subtemplate in self._subtemplates:
missing = subtemplate.parameter_names - external_parameters
if missing:
raise MissingParameterDeclarationException(
subtemplate, missing.pop())
remaining -= subtemplate.parameter_names
missing = self.constrained_parameters - external_parameters
if missing:
raise MissingParameterDeclarationException(self, missing.pop())
remaining -= self.constrained_parameters
if remaining:
raise MissingMappingException(self, remaining.pop())
duration = self._subtemplates[0].duration
for subtemplate in self._subtemplates[1:]:
if (duration == subtemplate.duration) is True:
continue
else:
raise ValueError(
'Could not assert duration equality of {} and {}'.format(
duration, subtemplate.duration))