|
+ TimeloopFE
+
+ |
+
| ▼Ntimeloopfe | |
| ▼Ncommon | |
| ►Nbase_specification | |
| ►Nnodes | Node classes for parsing and processing specification trees |
| ►Nprocessor | Base class for all processors |
| ▼Nv4 | Timeloop v4 Specification |
| ►Narch | |
| ►Ncomponents | |
| ►Nconstraints | |
| ►Nglobals | |
| ►Nmapper | |
| ►Nmapspace | |
| ►Nproblem | |
| ►Nprocessors | Standard suite of processors for timeloopfe |
| ►Nsparse_optimizations | |
| ►Nspecification | |
| ►Nvariables |
1.10.0
+
+
+
diff --git a/bc_s.png b/bc_s.png
new file mode 100644
index 0000000..224b29a
Binary files /dev/null and b/bc_s.png differ
diff --git a/bc_sd.png b/bc_sd.png
new file mode 100644
index 0000000..31ca888
Binary files /dev/null and b/bc_sd.png differ
diff --git a/classes.html b/classes.html
new file mode 100644
index 0000000..84276d9
--- /dev/null
+++ b/classes.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification-members.html b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification-members.html
new file mode 100644
index 0000000..8274c74
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification-members.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.base_specification.BaseSpecification, including all inherited members.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification.html b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification.html
new file mode 100644
index 0000000..543a6d0
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification.html
@@ -0,0 +1,599 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Base class for specifications in the Timeloop framework. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| + | needs_processing (self, Optional[List["Processor"]] with_processors=None, Optional[List["Processor"]] to_run=None) |
| process (self, Union["Processor", List["Processor"]] with_processors=None, bool check_types=False, bool check_types_ignore_empty=True, bool reprocess=True) | |
| Process the specification with the given processors. | |
| "Specification" | from_yaml_files (cls, *args, **kwargs) |
| Create a Specification object from YAML files. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in the specification. | |
 Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Public Attributes | |
| + | processors |
| + | spec |
| + | preserve_references |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
+Protected Member Functions | |
| + | _claim_nodes (self, *args, **kwargs) |
| + | _processors_declare_attrs (self, *args, **kwargs) |
| + | _early_init_processors (self, List["Processor"] _required_processors, **kwargs) |
| + | _process (self) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
+Protected Attributes | |
| + | _required_processors |
| + | _processor_attributes |
| + | _parsed_expressions |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
Base class for specifications in the Timeloop framework.
+Attributes: processors (ListNode): List of processors associated with the specification. _required_processors (ListNode): List of required processors. _parsed_expressions (bool): Flag indicating whether expressions have been parsed. _processors_run (List[Processor]): List of processors that have been run. preserve_references (bool): Flag indicating whether to preserve references.
+| timeloopfe.common.base_specification.BaseSpecification.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.common.base_specification.BaseSpecification.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +Reimplemented in timeloopfe.v4.specification.Specification.
+ +| timeloopfe.common.base_specification.BaseSpecification.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +Reimplemented in timeloopfe.v4.specification.Specification.
+ +| "Specification" timeloopfe.common.base_specification.BaseSpecification.from_yaml_files | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Create a Specification object from YAML files.
+Args: *args: YAML file paths. jinja_parse_data: Dictionary of data to be used for Jinja parsing.
+Returns: Specification: The created Specification object.
+ +Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.common.base_specification.BaseSpecification.parse_expressions | +( | +self, | +|
| + | + | Optional[Dict[str, Any]] | symbol_table = None, | +
| + | + | Optional[set] | parsed_ids = None ) | +
Parse expressions in the specification.
+Args: symbol_table (Optional[Dict[str, Any]], optional): Symbol table to be used for parsing. Defaults to None. parsed_ids (Optional[set], optional): Set of IDs of specifications that have already been parsed. Defaults to None.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +Reimplemented in timeloopfe.v4.specification.Specification.
+ +| timeloopfe.common.base_specification.BaseSpecification.process | +( | +self, | +|
| + | + | Union["Processor", List["Processor"]] | with_processors = None, | +
| + | + | bool | check_types = False, | +
| + | + | bool | check_types_ignore_empty = True, | +
| + | + | bool | reprocess = True ) | +
Process the specification with the given processors.
+Args: with_processors (Union[Processor, List[Processor]], optional): Processors to be used for processing the specification. Defaults to None. check_types (bool, optional): Flag indicating whether to check for unrecognized types. Defaults to False. check_types_ignore_empty (bool, optional): Flag indicating whether to ignore empty types during type checking. Defaults to True. reprocess (bool, optional): Flag indicating whether to reprocess the specification even if it has been processed before. Defaults to True.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.map b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.map
new file mode 100644
index 0000000..8d492a9
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.map
@@ -0,0 +1,12 @@
+
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.md5 b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.md5
new file mode 100644
index 0000000..a8f033f
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.md5
@@ -0,0 +1 @@
+711320bdd9a971c857b8caf790286eb5
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.png b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.png
new file mode 100644
index 0000000..b54ea55
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.map b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.map
new file mode 100644
index 0000000..9d04ce3
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.md5
new file mode 100644
index 0000000..1efc52d
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.md5
@@ -0,0 +1 @@
+81cfa0b6c2df1a5429fde53ad128198f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.png b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.png
new file mode 100644
index 0000000..189df35
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1base__specification_1_1BaseSpecification__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode-members.html
new file mode 100644
index 0000000..d122971
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.CombineableListNode, including all inherited members.
+| combine(self, "CombineableListNode" other) | timeloopfe.common.nodes.CombineableListNode |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode.html b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode.html
new file mode 100644
index 0000000..bf09f3a
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode.html
@@ -0,0 +1,328 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list node that can be combined with others by extending. + More...
+
+Public Member Functions | |
| "CombineableListNode" | combine (self, "CombineableListNode" other) |
| Extends this list with the contents of another list. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list node that can be combined with others by extending.
+| "CombineableListNode" timeloopfe.common.nodes.CombineableListNode.combine | +( | +self, | +|
| + | + | "CombineableListNode" | other ) | +
Extends this list with the contents of another list.
+ +Reimplemented in timeloopfe.v4.constraints.Factors.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.map
new file mode 100644
index 0000000..91eb90f
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.md5
new file mode 100644
index 0000000..2dea154
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.md5
@@ -0,0 +1 @@
+f9d32c06adf0df1c41ffdf23fbb30b5b
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.png
new file mode 100644
index 0000000..cb43318
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.map
new file mode 100644
index 0000000..f619e10
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.map
@@ -0,0 +1,17 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.md5
new file mode 100644
index 0000000..cbcd8d4
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.md5
@@ -0,0 +1 @@
+f793308cea9bd82faaf655dbf656cb64
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.png
new file mode 100644
index 0000000..b887ca1
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode-members.html
new file mode 100644
index 0000000..4a9cba2
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode-members.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.DictNode, including all inherited members.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode.html b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode.html
new file mode 100644
index 0000000..da43c8d
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode.html
@@ -0,0 +1,637 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A node that is a dictionary of other nodes. + More...
+
+Public Member Functions | |
| __init__ (self, *args, __node_skip_parse=False, **kwargs) | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Public Attributes | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
+Protected Member Functions | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
+Static Protected Member Functions | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
+Protected Attributes | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
A node that is a dictionary of other nodes.
+| timeloopfe.common.nodes.DictNode.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | __node_skip_parse = False, | +|
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.Node.
+ +| Any timeloopfe.common.nodes.DictNode.__getitem__ | +( | +self, | +|
| + | + | Any | key ) | +
Get the value at the given key or index.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| None timeloopfe.common.nodes.DictNode.__setitem__ | +( | +self, | +|
| + | + | Any | key, | +
| + | + | Any | value ) | +
Set the value at the given key or index.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| None timeloopfe.common.nodes.DictNode.check_unrecognized | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Check for unrecognized keys in this node and all subnodes.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| "DictNode" timeloopfe.common.nodes.DictNode.combine | +( | +self, | +|
| + | + | "DictNode" | other ) | +
Combines this dictionary with another dictionary.
+If a key is present in both dictionaries, the values are combined. Otherwise, the key is taken from whichever dictionary has it.
+ +Reimplemented in timeloopfe.v4.arch.Architecture, and timeloopfe.v4.constraints.Constraint.
+ +| "DictNode" timeloopfe.common.nodes.DictNode.from_yaml_files | +( | +cls, | +|
| + | + | *Union[str, List[str]] | files, | +
| + | + | Dict[str, Any] | jinja_parse_data = None, | +
| + | + | ** | kwargs ) | +
Loads a dictionary from one more more yaml files.
+Each yaml file should contain a dictionary. Dictionaries are combined in the order they are given.
+Keyword arguments are also added to the dictionary.
+Args: files: A list of yaml files to load. jinja_parse_data: A dictionary of data to use when parsing kwargs: Extra keyword arguments to add to the dictionary.
+Returns: A DictNode containing the combined dictionaries.
+Loads a dictionary from a list of yaml files. Each yaml file should contain a dictionary. Dictionaries are in the given order. Keyword arguments are also added to the dictionary. !
| files | A list of yaml files to load. ! |
| jinja_parse_data | A dictionary of data to use when parsing ! |
| kwargs | Extra keyword arguments to add to the dictionary. |
Reimplemented in timeloopfe.common.base_specification.BaseSpecification.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.map
new file mode 100644
index 0000000..cf8a743
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.map
@@ -0,0 +1,9 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.md5
new file mode 100644
index 0000000..a4c4dbe
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.md5
@@ -0,0 +1 @@
+15f2d75c235fbcb64a92015b3df195d0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.png
new file mode 100644
index 0000000..bfbfd59
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.map
new file mode 100644
index 0000000..8ac0d27
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.map
@@ -0,0 +1,101 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.md5
new file mode 100644
index 0000000..8d6c5f9
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.md5
@@ -0,0 +1 @@
+6bf40ae16f31676666041d0ae57bc179
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.png
new file mode 100644
index 0000000..351764f
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1DictNode__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode-members.html
new file mode 100644
index 0000000..6fd410c
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.FlatteningListNode, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.common.nodes.FlatteningListNode) | timeloopfe.common.nodes.FlatteningListNode | |
| _flatten(self) (defined in timeloopfe.common.nodes.FlatteningListNode) | timeloopfe.common.nodes.FlatteningListNode | protected |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode.html b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode.html
new file mode 100644
index 0000000..20cdc96
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode.html
@@ -0,0 +1,330 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list node that flattens lists of lists. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Protected Member Functions | |
| + | _flatten (self) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list node that flattens lists of lists.
+| timeloopfe.common.nodes.FlatteningListNode.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.map
new file mode 100644
index 0000000..4362b96
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.md5
new file mode 100644
index 0000000..b3b530a
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.md5
@@ -0,0 +1 @@
+ed2a17bf24df3deb3facb9a08154b392
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.png
new file mode 100644
index 0000000..32c62d8
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.map
new file mode 100644
index 0000000..f3b7717
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.md5
new file mode 100644
index 0000000..570b766
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.md5
@@ -0,0 +1 @@
+44d420357befd054f08a83fb0429473c
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.png
new file mode 100644
index 0000000..db6ba95
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1FlatteningListNode__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1GrabParentAddMe-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1GrabParentAddMe-members.html
new file mode 100644
index 0000000..7026ac8
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1GrabParentAddMe-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.GrabParentAddMe, including all inherited members.
+| __enter__(self) (defined in timeloopfe.common.nodes.GrabParentAddMe) | timeloopfe.common.nodes.GrabParentAddMe | |
| __exit__(self, *args) (defined in timeloopfe.common.nodes.GrabParentAddMe) | timeloopfe.common.nodes.GrabParentAddMe | |
| __init__(self, "Node" add_elem) (defined in timeloopfe.common.nodes.GrabParentAddMe) | timeloopfe.common.nodes.GrabParentAddMe | |
| add_elem (defined in timeloopfe.common.nodes.GrabParentAddMe) | timeloopfe.common.nodes.GrabParentAddMe |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1GrabParentAddMe.html b/classtimeloopfe_1_1common_1_1nodes_1_1GrabParentAddMe.html
new file mode 100644
index 0000000..949ac94
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1GrabParentAddMe.html
@@ -0,0 +1,113 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
+Public Member Functions | |
| + | __init__ (self, "Node" add_elem) |
| + | __enter__ (self) |
| + | __exit__ (self, *args) |
+Public Attributes | |
| + | add_elem |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode-members.html
new file mode 100644
index 0000000..a21884b
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.ListNode, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.common.nodes.ListNode) | timeloopfe.common.nodes.ListNode |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode.html b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode.html
new file mode 100644
index 0000000..31c59e3
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode.html
@@ -0,0 +1,359 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A node that is a list of other nodes. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A node that is a list of other nodes.
+| timeloopfe.common.nodes.ListNode.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.map
new file mode 100644
index 0000000..53f5e5d
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.map
@@ -0,0 +1,9 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.md5
new file mode 100644
index 0000000..d7a5d07
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.md5
@@ -0,0 +1 @@
+911bedbe8422975ab629fa741e918c9a
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.png
new file mode 100644
index 0000000..e738ee3
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.map
new file mode 100644
index 0000000..c279328
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.map
@@ -0,0 +1,51 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.md5
new file mode 100644
index 0000000..8ef291e
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.md5
@@ -0,0 +1 @@
+aa446a4d9caca7e3016db55d4d69bdec
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.png
new file mode 100644
index 0000000..577390e
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1ListNode__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1Node-members.html
new file mode 100644
index 0000000..b312cba
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Node-members.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.Node, including all inherited members.
+| __format__(self, format_spec) | timeloopfe.common.nodes.Node | |
| __getitem__(self, Union[str, int] key) | timeloopfe.common.nodes.Node | |
| __init__(self, *args, **kwargs) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | |
| __setitem__(self, Union[str, int] key, Any value) | timeloopfe.common.nodes.Node | |
| __str__(self) | timeloopfe.common.nodes.Node | |
| _check_unrecognized(self, ignore_empty=False, ignore_should_have_been_removed_by=False) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| _default_parse (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| _get_all_recognized(self) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| _get_index2checker(self, Optional[List[Tuple[str, Any]]] key2elem=None) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| _get_tag(x) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protectedstatic |
| _get_type_specifiers(cls, "BaseSpecification" spec) | timeloopfe.common.nodes.Node | protected |
| _parse_elem(self, Union[str, int] key, TypeSpecifier check, Any value_override=None) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| _parse_elems(self) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| _parse_expression(self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| _parse_extra_elems(self, List[Tuple[str, Any]] key2elem) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | protected |
| add_attr(cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | timeloopfe.common.nodes.Node | |
| check_unrecognized(self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | timeloopfe.common.nodes.Node | |
| clean_empties(self) | timeloopfe.common.nodes.Node | |
| combine_index(self, Union[str, int] key, T value) | timeloopfe.common.nodes.Node | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.common.nodes.Node | |
| get_combiner_lambda(self, Union[str, int] keytag) | timeloopfe.common.nodes.Node | |
| get_combiners_for_keytag(self, str keytag, bool recursive=True) | timeloopfe.common.nodes.Node | |
| get_combiners_for_type(self, Type t, bool recursive=True) | timeloopfe.common.nodes.Node | |
| get_global_spec() | timeloopfe.common.nodes.Node | static |
| get_name(self, Union[Set, None] seen=None) | timeloopfe.common.nodes.Node | |
| get_nodes_of_type(self, Type[T] node_type) | timeloopfe.common.nodes.Node | |
| get_setter_lambda(self, Union[str, int] keytag) | timeloopfe.common.nodes.Node | |
| get_setters_for_keytag(self, str keytag, bool recursive=True) | timeloopfe.common.nodes.Node | |
| get_setters_for_type(self, Type t, bool recursive=True) | timeloopfe.common.nodes.Node | |
| get_specifiers_from_processors(cls, "BaseSpecification" spec) | timeloopfe.common.nodes.Node | |
| get_tag(self) | timeloopfe.common.nodes.Node | |
| is_defined_non_default_non_empty(self, str key) | timeloopfe.common.nodes.Node | |
| isempty(self) | timeloopfe.common.nodes.Node | |
| isempty_recursive(self) | timeloopfe.common.nodes.Node | |
| items(self) | timeloopfe.common.nodes.Node | |
| logger (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | |
| parent_node (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | |
| parse_expressions(self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | timeloopfe.common.nodes.Node | |
| recognize_all(cls, bool recognize_all=True) | timeloopfe.common.nodes.Node | |
| recursive_apply(self, callable func, bool self_first=False, set applied_to=None) | timeloopfe.common.nodes.Node | |
| reset_processor_elems(cls, Optional[Type] processor=None) (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | |
| reset_specifiers_from_processors(cls, Optional[Type] processor=None) | timeloopfe.common.nodes.Node | |
| set_global_spec("BaseSpecification" spec) | timeloopfe.common.nodes.Node | static |
| spec (defined in timeloopfe.common.nodes.Node) | timeloopfe.common.nodes.Node | |
| try_combine(Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) | timeloopfe.common.nodes.Node | static |
| unique_class_name(cls) | timeloopfe.common.nodes.Node |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node.html b/classtimeloopfe_1_1common_1_1nodes_1_1Node.html
new file mode 100644
index 0000000..875196a
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Node.html
@@ -0,0 +1,1018 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Base class for all nodes in the hierarchy. + More...
+
+Public Member Functions | |
| + | __init__ (self, *args, **kwargs) |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Static Public Member Functions | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
+Public Attributes | |
| + | logger |
| + | parent_node |
| + | spec |
+Protected Member Functions | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
+Static Protected Member Functions | |
| +str | _get_tag (x) |
+Protected Attributes | |
| + | _default_parse |
Base class for all nodes in the hierarchy.
+Attributes: parent_node (Node): The parent node of the current node. spec (Specification): The global specification object. _init_args (Tuple): The arguments and keyword arguments used to initialize the node. __currently_parsing_index (Union[int, str]): The index or key currently being parsed. logger (Logger): The logger object for the node's class. _default_parse (bool): Flag indicating whether the node should be parsed using default rules.
+Methods: get_specifiers_from_processors(cls, spec): Get the specifiers from processors. reset_specifiers_from_processors(cls, processor): Reset the specifiers from processors. declare_attrs(cls, *args, **kwargs): Initialize the attributes of this node. reset_processor_elems(cls, processor): Reset the processor elements. recognize_all(cls, recognize_all): Set whether all attributes under this node should be recognized. _get_type_specifiers(cls, spec): Get the type specifiers for this node. _get_all_recognized(self): Check if all attributes under this node are recognized. _get_tag(x): Get the tag of a node. get_global_spec(): Get the global specification object. set_global_spec(spec): Set the global specification object. get_tag(self): Get the tag of this node. _get_index2checker(self, key2elem): Get the index-to-checker mapping. items(self): Get an iterable of (key, value) or (index, value) pairs. combine_index(self, key, value): Combine the value at the given key with the given value. _parse_elem(self, key, check, value_override): Parse an element of the node.
+| Any timeloopfe.common.nodes.Node.__getitem__ | +( | +self, | +|
| + | + | Union[str, int] | key ) | +
Get the value at the given key or index.
+ +Reimplemented in timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.common.nodes.Node.__setitem__ | +( | +self, | +|
| + | + | Union[str, int] | key, | +
| + | + | Any | value ) | +
Set the value at the given key or index.
+ +Reimplemented in timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.common.nodes.Node.__str__ | +( | +self | ) | ++ |
Return the name of this node.
+ +Reimplemented in timeloopfe.v4.constraints.Constraint.
+ +
+
|
+ +protected | +
Get the type specifiers for this node.
+Attributes: spec (Specification): The global specification object.
+Returns: Dict[str, TypeSpecifier]: The type specifiers for this node.
+ +| timeloopfe.common.nodes.Node.add_attr | +( | +cls, | +|
| + | + | str | key_or_tag, | +
| + | + | Optional[ + Union[type, Tuple[type, ...], Tuple[None, ...], Tuple[str, ...], None] + ] | required_type = None, | +
| + | + | Any | default = default_unspecified_, | +
| + | + | Optional[Callable] | callfunc = None, | +
| + | + | Optional[bool] | part_name_match = None, | +
| + | + | Optional[bool] | no_change_key = None, | +
| + | + | Any | _processor_responsible_for_removing = None, | +
| + | + | Optional[Dict[str, TypeSpecifier]] | _add_checker_to = None ) | +
Initialize a type specifier for this class.
+Args: key_or_tag: The key/tag or tag to use for this type specifier. required_type: The type of value that this type specifier will be default: The default value to use if the key/tag is not found. callfunc: A function to call on the value before returning it. part_name_match: If True, the key/tag will match if it is a substring of the actual key/tag. no_change_key: If True, a parsed key will not be changed when a partial name match is found. Otherwise, the parsed key will be changed to the actual key. _processor_responsible_for_removing: The processor that will be responsible for removing this key from the containing node, if any. _add_checker_to: The dictionary to add the checker to. If None, add the checker to the class's type specifiers.
+Raises: AttributeError: If the class does not have a _param_type_specifiers attribute.
+ +| timeloopfe.common.nodes.Node.check_unrecognized | +( | +self, | +|
| + | + | bool | ignore_empty = False, | +
| + | + | ignore_should_have_been_removed_by = False ) | +
Check for unrecognized keys in this node and all subnodes.
+Also checks for correct types.
+Args: ignore_empty (bool): Flag indicating whether to ignore empty nodes. ignore_should_have_been_removed_by (bool): Flag indicating whether to ignore nodes that should have been removed by a processor.
+Raises: ParseError: If an unrecognized key is found.
+ +Reimplemented in timeloopfe.common.nodes.DictNode.
+ +| T timeloopfe.common.nodes.Node.combine_index | +( | +self, | +|
| + | + | Union[str, int] | key, | +
| + | + | T | value ) | +
Combine the value at the given key with the given value.
+If there is no value at the given key, sets the value at the given key. If there is, attempts to combine the two values.
+Args: key: The key to combine. value: The value to combine.
+Returns: The combined value.
+ +| timeloopfe.common.nodes.Node.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented in timeloopfe.common.base_specification.BaseSpecification, timeloopfe.common.base_specification.BaseSpecification, timeloopfe.v4.arch.ArchNodes, timeloopfe.v4.arch.Branch, timeloopfe.v4.arch.Architecture, timeloopfe.v4.arch.Leaf, timeloopfe.v4.arch.Component, timeloopfe.v4.arch.Container, timeloopfe.v4.arch.Networks, timeloopfe.v4.arch.Storage, timeloopfe.v4.arch.Compute, timeloopfe.v4.arch.Network, timeloopfe.v4.arch.Spatial, timeloopfe.v4.arch.Attributes, timeloopfe.v4.arch.StorageAttributes, timeloopfe.v4.arch.StorageAttributes, timeloopfe.v4.arch.Nothing, timeloopfe.v4.components.Components, timeloopfe.v4.components.ComponentsList, timeloopfe.v4.components.CompoundComponent, timeloopfe.v4.components.SubcomponentList, timeloopfe.v4.components.Subcomponent, timeloopfe.v4.components.ComponentAttributes, timeloopfe.v4.components.ActionsList, timeloopfe.v4.components.Action, timeloopfe.v4.components.ActionSubcomponentsList, timeloopfe.v4.components.SubcomponentActionGroup, timeloopfe.v4.components.SubcomponentActionList, timeloopfe.v4.components.SubcomponentAction, timeloopfe.v4.constraints.Constraints, timeloopfe.v4.constraints.ConstraintsList, timeloopfe.v4.constraints.Constraint, timeloopfe.v4.constraints.ConstraintGroup, timeloopfe.v4.constraints.Iteration, timeloopfe.v4.constraints.Spatial, timeloopfe.v4.constraints.Temporal, timeloopfe.v4.constraints.Dataspace, timeloopfe.v4.constraints.MaxOverbookedProportion, timeloopfe.v4.constraints.Utilization, timeloopfe.v4.constraints.Permutation, timeloopfe.v4.constraints.Factors, timeloopfe.v4.constraints.ProblemDataspaceList, timeloopfe.v4.globals.Globals, timeloopfe.v4.globals.EnvironmentVariables, timeloopfe.v4.globals.ExpressionCustomFunctions, timeloopfe.v4.mapper.Mapper, timeloopfe.v4.mapper.OptimizationMetrics, timeloopfe.v4.mapspace.Mapspace, timeloopfe.v4.problem.Problem, timeloopfe.v4.problem.Shape, timeloopfe.v4.problem.ProblemDataspaceList, timeloopfe.v4.problem.Instance, timeloopfe.v4.problem.DataSpace, timeloopfe.v4.problem.DensityList, timeloopfe.v4.problem.Density, timeloopfe.v4.sparse_optimizations.SparseOptimizations, timeloopfe.v4.sparse_optimizations.SparseOptimizationsList, timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup, timeloopfe.v4.sparse_optimizations.RepresentationFormat, timeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList, timeloopfe.v4.sparse_optimizations.RepresentationDataSpace, timeloopfe.v4.sparse_optimizations.RepresentationRankList, timeloopfe.v4.sparse_optimizations.RepresentationRank, timeloopfe.v4.sparse_optimizations.ActionOptimizationList, timeloopfe.v4.sparse_optimizations.ComputeOptimization, timeloopfe.v4.sparse_optimizations.ActionOptimization, timeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList, timeloopfe.v4.sparse_optimizations.ActionOptimizationOption, timeloopfe.v4.specification.Specification, and timeloopfe.v4.variables.Variables.
+ +| Callable timeloopfe.common.nodes.Node.get_combiner_lambda | +( | +self, | +|
| + | + | Union[str, int] | keytag ) | +
Get a function that can be used to combine a value to this node.
+The combiner takes one argument, the value to combine.
+Args: keytag: The key or tag to combine.
+Returns: A function that can be used to combine a value to this node.
+ +| List[Tuple[Any, Callable]] timeloopfe.common.nodes.Node.get_combiners_for_keytag | +( | +self, | +|
| + | + | str | keytag, | +
| + | + | bool | recursive = True ) | +
Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag.
+A combiner is a function that can be used to combine a value to this node.
+Args: keytag: The key or tag to search for. recursive: If True, search recursively.
+ +| List[Tuple[Any, Callable]] timeloopfe.common.nodes.Node.get_combiners_for_type | +( | +self, | +|
| + | + | Type | t, | +
| + | + | bool | recursive = True ) | +
Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.
+A combiner is a function that can be used to combine a value in this node.
+Args: t: The type to search for. recursive: If True, search recursively.
+Returns: A list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.
+ +| List[T] timeloopfe.common.nodes.Node.get_nodes_of_type | +( | +self, | +|
| + | + | Type[T] | node_type ) | +
Return a list of all subnodes of a given type.
+Args: node_type: The type of node to search for.
+Returns: A list of all subnodes of the given type.
+ +| Callable timeloopfe.common.nodes.Node.get_setter_lambda | +( | +self, | +|
| + | + | Union[str, int] | keytag ) | +
Get a function that can be used to set a value in this node.
+The setter takes one argument, the value to set.
+Args: keytag: The key or tag to set.
+Returns: A function that can be used to set a value in this node.
+ +| List[Tuple[Any, Callable]] timeloopfe.common.nodes.Node.get_setters_for_keytag | +( | +self, | +|
| + | + | str | keytag, | +
| + | + | bool | recursive = True ) | +
Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag.
+A setter is a function that can be used to set a value in this node.
+Args: keytag: The key or tag to search for. recursive: If True, search recursively.
+ +| List[Tuple[Any, Callable]] timeloopfe.common.nodes.Node.get_setters_for_type | +( | +self, | +|
| + | + | Type | t, | +
| + | + | bool | recursive = True ) | +
Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.
+A setter is a function that can be used to set a value in this node.
+Args: t: The type to search for. recursive: If True, search recursively.
+Returns: A list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.
+ +| bool timeloopfe.common.nodes.Node.isempty | +( | +self | ) | ++ |
Return True if this node is empty.
+Good to override.
+ +Reimplemented in timeloopfe.v4.constraints.Constraint, and timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup.
+ +| timeloopfe.common.nodes.Node.parse_expressions | +( | +self, | +|
| + | + | Optional[Dict[str, Any]] | symbol_table = None, | +
| + | + | Optional[set] | parsed_ids = None, | +
| + | + | Optional[Callable] | callfunc = None ) | +
Parse expressions in this node and all subnodes.
+Args: symbol_table: A dictionary mapping variable names to values. parsed_ids: A set of IDs of nodes that have already been parsed. callfunc: A function to call on each node after parsing.
+ +Reimplemented in timeloopfe.common.base_specification.BaseSpecification, timeloopfe.v4.arch.ArchNodes, timeloopfe.v4.arch.Branch, timeloopfe.v4.arch.Leaf, timeloopfe.v4.components.Components, and timeloopfe.v4.specification.Specification.
+ +| timeloopfe.common.nodes.Node.recognize_all | +( | +cls, | +|
| + | + | bool | recognize_all = True ) | +
Set whether all attributes under this node should be recognized.
+Attributes: recognize_all (bool): Flag indicating whether all attributes under this node should be recognized.
+ +| Any timeloopfe.common.nodes.Node.recursive_apply | +( | +self, | +|
| + | + | callable | func, | +
| + | + | bool | self_first = False, | +
| + | + | set | applied_to = None ) | +
Apply a function to this node and all subnodes.
+Args: func (callable): The function to apply. self_first (bool): Flag indicating whether to apply the function to this node before applying it to subnodes. applied_to (set): A set of ids of nodes that have already been visited. Prevents infinite recursion.
+Returns: The return value of the function applied to this node.
+ +
+
|
+ +static | +
Try to combine two values.
+Args: a: The first value. b: The second value. innonde: The node that contains the values. For error messages. index: The index of the values in the node. For error messages.
+Returns: The combined value.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.map
new file mode 100644
index 0000000..92af421
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.md5
new file mode 100644
index 0000000..765ccdb
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.md5
@@ -0,0 +1 @@
+a81a6bd09e87e0517b98df1d5bdd5d49
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.png
new file mode 100644
index 0000000..e3aea07
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1Node__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.map
new file mode 100644
index 0000000..8217edd
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.map
@@ -0,0 +1,103 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.md5
new file mode 100644
index 0000000..34fee0d
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.md5
@@ -0,0 +1 @@
+abac591769fc8aaf776ffe1fa7dfd0a4
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.png
new file mode 100644
index 0000000..b576e53
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1Node__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ParseError.html b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError.html
new file mode 100644
index 0000000..f19deb1
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError.html
@@ -0,0 +1,115 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Exception for nodes. + More...
+
Exception for nodes.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.map
new file mode 100644
index 0000000..502dd2d
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.md5
new file mode 100644
index 0000000..4003576
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.md5
@@ -0,0 +1 @@
+47ea7bd5ca015e7620d462d445c4b4f0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.png
new file mode 100644
index 0000000..307291a
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.map
new file mode 100644
index 0000000..502dd2d
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.md5
new file mode 100644
index 0000000..4003576
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.md5
@@ -0,0 +1 @@
+47ea7bd5ca015e7620d462d445c4b4f0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.png
new file mode 100644
index 0000000..307291a
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_1_1ParseError__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1TypeSpecifier-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1TypeSpecifier-members.html
new file mode 100644
index 0000000..14c6a0e
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1TypeSpecifier-members.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.TypeSpecifier, including all inherited members.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1TypeSpecifier.html b/classtimeloopfe_1_1common_1_1nodes_1_1TypeSpecifier.html
new file mode 100644
index 0000000..15e1f91
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1TypeSpecifier.html
@@ -0,0 +1,138 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Represents a type specifier for a node in the TimeloopFE library. + More...
++Public Attributes | |
| + | callfunc |
| + | should_have_been_removed_by |
| + | required_type |
Represents a type specifier for a node in the TimeloopFE library.
+Attributes: name (str): The name of the type specifier. required_type (Type): The required type for the node. default (Any): The default value for the type specifier. callfunc (Union[Callable, None]): The function to call for casting the value. should_have_been_removed_by (Type): The type that should have removed or transformed the node. part_name_match (bool): Flag indicating if the name should be partially matched. no_change_key (bool): Flag indicating if the key should not be changed.
+Methods: get_id2casted(cls): Get the dictionary of casted values. reset_id2casted(cls): Reset the dictionary of casted values. removed_by_str(self): Get the string representation of the type that should have removed or transformed the node. cast_check_type(self, value: Any, node: "Node", key: str) -> Any: Check and cast the value to the required type. cast(self, value: Any, __node_skip_parse: bool = False) -> Any: Cast the value to the required type. check_type(self, value: Any, node: "Node", key: str): Check if the value matches the required type.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Unspecified-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1Unspecified-members.html
new file mode 100644
index 0000000..03af49b
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Unspecified-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.nodes.Unspecified, including all inherited members.
+| __repr__(self) (defined in timeloopfe.common.nodes.Unspecified) | timeloopfe.common.nodes.Unspecified | |
| __str__(self) (defined in timeloopfe.common.nodes.Unspecified) | timeloopfe.common.nodes.Unspecified |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1Unspecified.html b/classtimeloopfe_1_1common_1_1nodes_1_1Unspecified.html
new file mode 100644
index 0000000..4c6b85a
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1nodes_1_1Unspecified.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Class to represent an unspecified value. + More...
++Public Member Functions | |
| + | __str__ (self) |
| + | __repr__ (self) |
Class to represent an unspecified value.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor-members.html b/classtimeloopfe_1_1common_1_1processor_1_1Processor-members.html
new file mode 100644
index 0000000..4bd8791
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1Processor-members.html
@@ -0,0 +1,98 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.processor.Processor, including all inherited members.
+| __init__(self, Optional["Specification"] spec=None) (defined in timeloopfe.common.processor.Processor) | timeloopfe.common.processor.Processor | |
| add_attr(self, Node target, *args, **kwargs) (defined in timeloopfe.common.processor.Processor) | timeloopfe.common.processor.Processor | |
| declare_attrs(self) | timeloopfe.common.processor.Processor | |
| get_index(self, type processor_type, "Specification" spec) | timeloopfe.common.processor.Processor | |
| logger (defined in timeloopfe.common.processor.Processor) | timeloopfe.common.processor.Processor | |
| must_run_after(self, type other, "Specification" spec, bool ok_if_not_found=False) | timeloopfe.common.processor.Processor | |
| process(self, "Specification" spec) | timeloopfe.common.processor.Processor | |
| spec (defined in timeloopfe.common.processor.Processor) | timeloopfe.common.processor.Processor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor.html b/classtimeloopfe_1_1common_1_1processor_1_1Processor.html
new file mode 100644
index 0000000..22f437a
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1Processor.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Base class for all processors, which are used to modify the specification before it is passed to Accelergy/Timeloop. + More...
+
+Public Member Functions | |
| + | __init__ (self, Optional["Specification"] spec=None) |
| process (self, "Specification" spec) | |
| Process the specification. | |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Public Attributes | |
| + | logger |
| + | spec |
Base class for all processors, which are used to modify the specification before it is passed to Accelergy/Timeloop.
+Attributes: spec: The specification to process. logger: The logger for this processor.
+| timeloopfe.common.processor.Processor.declare_attrs | +( | +self | ) | ++ |
Initialize the attributes that the processor is responsible for.
+!
Reimplemented in timeloopfe.common.processor.SimpleProcessor, timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor, and timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor.
+ +| timeloopfe.common.processor.Processor.must_run_after | +( | +self, | +|
| + | + | type | other, | +
| + | + | "Specification" | spec, | +
| + | + | bool | ok_if_not_found = False ) | +
Ensure that this processor runs after another processor.
+!
| other | The processor that this processor must run after. |
!
| ok_if_not_found | If False, OK if the other processor is not found. If True, raise an exception if the other processor is not found. |
| timeloopfe.common.processor.Processor.process | +( | +self, | +|
| + | + | "Specification" | spec ) | +
Process the specification.
+ +Reimplemented in timeloopfe.common.processor.References2CopiesProcessor, timeloopfe.common.processor.SimpleProcessor, timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor, timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor, timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor, timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor, timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor, timeloopfe.v4.processors.required_actions.RequiredActionsProcessor, and timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError.html b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError.html
new file mode 100644
index 0000000..f8924b9
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError.html
@@ -0,0 +1,115 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Exception raised by processors. + More...
+
Exception raised by processors.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.map
new file mode 100644
index 0000000..95d6ee3
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.md5
new file mode 100644
index 0000000..2f7bf1a
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.md5
@@ -0,0 +1 @@
+70bd2ec730c92d99953cc4dba3b22860
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.png
new file mode 100644
index 0000000..df1d94c
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.map
new file mode 100644
index 0000000..95d6ee3
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.md5
new file mode 100644
index 0000000..2f7bf1a
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.md5
@@ -0,0 +1 @@
+70bd2ec730c92d99953cc4dba3b22860
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.png
new file mode 100644
index 0000000..df1d94c
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1ProcessorError__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.map
new file mode 100644
index 0000000..8e330b8
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.md5
new file mode 100644
index 0000000..467ce0c
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.md5
@@ -0,0 +1 @@
+02bebeff86e2c17cdfab1d63dd8a4d5a
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.png
new file mode 100644
index 0000000..72cddb8
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1Processor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.map
new file mode 100644
index 0000000..01df5ff
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.map
@@ -0,0 +1,23 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.md5
new file mode 100644
index 0000000..8816a6c
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.md5
@@ -0,0 +1 @@
+01013fa1dac3521e21bd919c3eaea1cb
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.png
new file mode 100644
index 0000000..76d72df
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1Processor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor-members.html b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor-members.html
new file mode 100644
index 0000000..dd772da
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.processor.References2CopiesProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.common.processor.References2CopiesProcessor) | timeloopfe.common.processor.References2CopiesProcessor | |
| process(self, "BaseSpecification" spec) | timeloopfe.common.processor.References2CopiesProcessor | |
| refs2copies_fast(self, "BaseSpecification" spec, Any n, seen_ids=None, visited=None, depth=0) (defined in timeloopfe.common.processor.References2CopiesProcessor) | timeloopfe.common.processor.References2CopiesProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor.html b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor.html
new file mode 100644
index 0000000..7903015
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor.html
@@ -0,0 +1,213 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Converts references to copies in the specification. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| process (self, "BaseSpecification" spec) | |
| Process the specification. | |
| +Any | refs2copies_fast (self, "BaseSpecification" spec, Any n, seen_ids=None, visited=None, depth=0) |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Converts references to copies in the specification.
+| timeloopfe.common.processor.References2CopiesProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.common.processor.References2CopiesProcessor.process | +( | +self, | +|
| + | + | "BaseSpecification" | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.map
new file mode 100644
index 0000000..088dfad
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.md5
new file mode 100644
index 0000000..96defd5
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.md5
@@ -0,0 +1 @@
+87928aa51ebfed96328c734197d7956a
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.png
new file mode 100644
index 0000000..3aed624
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.map
new file mode 100644
index 0000000..088dfad
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.md5
new file mode 100644
index 0000000..96defd5
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+87928aa51ebfed96328c734197d7956a
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.png
new file mode 100644
index 0000000..3aed624
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1References2CopiesProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor-members.html b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor-members.html
new file mode 100644
index 0000000..65ac9c3
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.common.processor.SimpleProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.common.processor.SimpleProcessor) | timeloopfe.common.processor.SimpleProcessor | |
| declare_attrs(self) | timeloopfe.common.processor.SimpleProcessor | |
| process(self, "Specification" spec) | timeloopfe.common.processor.SimpleProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor.html b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor.html
new file mode 100644
index 0000000..c693c27
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor.html
@@ -0,0 +1,232 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
An example simple processor. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| declare_attrs (self) | |
| Initialize the attributes that the processor handles. | |
| process (self, "Specification" spec) | |
| Process the specification. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
An example simple processor.
+| timeloopfe.common.processor.SimpleProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.common.processor.SimpleProcessor.declare_attrs | +( | +self | ) | ++ |
Initialize the attributes that the processor handles.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.common.processor.SimpleProcessor.process | +( | +self, | +|
| + | + | "Specification" | spec ) | +
Process the specification.
+Remove attributes that this processor is responsible for.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.map
new file mode 100644
index 0000000..e85c6bd
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.md5
new file mode 100644
index 0000000..1fe1d6f
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.md5
@@ -0,0 +1 @@
+7f3c19076ffde3d2f0dcd660d5605306
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.png
new file mode 100644
index 0000000..02c26a6
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.map b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.map
new file mode 100644
index 0000000..e85c6bd
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.md5
new file mode 100644
index 0000000..1fe1d6f
--- /dev/null
+++ b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+7f3c19076ffde3d2f0dcd660d5605306
\ No newline at end of file
diff --git a/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.png b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.png
new file mode 100644
index 0000000..02c26a6
Binary files /dev/null and b/classtimeloopfe_1_1common_1_1processor_1_1SimpleProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode-members.html
new file mode 100644
index 0000000..ef87a00
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.ArchNode, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.ArchNode) | timeloopfe.v4.arch.ArchNode | |
| find(self, *args, **kwargs) | timeloopfe.v4.arch.ArchNode | |
| name2constraints(self, str name) | timeloopfe.v4.arch.ArchNode | |
| name2leaf(self, str name) | timeloopfe.v4.arch.ArchNode |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode.html b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode.html
new file mode 100644
index 0000000..d750cc4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode.html
@@ -0,0 +1,404 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A node in the architecture hierarchy. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A node in the architecture hierarchy.
+Methods: name2leaf: Finds a leaf node with the given name. find: Alias for name2leaf method. name2constraints: Retrieves the constraints of a leaf node with the given name.
+Raises: ValueError: If the leaf node with the given name is not found.
+Returns: None
+| timeloopfe.v4.arch.ArchNode.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.Node.
+ +| "constraints.ConstraintGroup" timeloopfe.v4.arch.ArchNode.name2constraints | +( | +self, | +|
| + | + | str | name ) | +
Retrieves the constraints of a leaf node with the given name.
+Args: name (str): The name of the leaf node.
+Returns: constraints.ConstraintGroup: The constraints of the leaf node.
+ +| "Leaf" timeloopfe.v4.arch.ArchNode.name2leaf | +( | +self, | +|
| + | + | str | name ) | +
Finds a leaf node with the given name.
+Args: name (str): The name of the leaf node to find.
+Returns: Leaf: The leaf node with the given name.
+Raises: ValueError: If the leaf node with the given name is not found.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.map
new file mode 100644
index 0000000..ea35bde
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.md5
new file mode 100644
index 0000000..e485e22
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.md5
@@ -0,0 +1 @@
+867a932925640f1ba5f8a2bc03cab1da
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.png
new file mode 100644
index 0000000..e97e80c
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.map
new file mode 100644
index 0000000..7782d92
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.map
@@ -0,0 +1,33 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.md5
new file mode 100644
index 0000000..f6022b0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.md5
@@ -0,0 +1 @@
+6f03e21be7859ef15b82cdfbc574fdb5
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.png
new file mode 100644
index 0000000..a74a7e2
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNode__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes-members.html
new file mode 100644
index 0000000..5a9e972
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.ArchNodes, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.ArchNodes) | timeloopfe.v4.arch.ArchNodes | |
| __repr__(self) | timeloopfe.v4.arch.ArchNodes | |
| combine(self, "ArchNodes" other) | timeloopfe.v4.arch.ArchNodes | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.ArchNodes | |
| parse_expressions(self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | timeloopfe.v4.arch.ArchNodes |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes.html b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes.html
new file mode 100644
index 0000000..f1842af
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes.html
@@ -0,0 +1,455 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A collection of architectural nodes. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| "ArchNodes" | combine (self, "ArchNodes" other) |
Combines two ArchNodes instances. | |
| __repr__ (self) | |
Returns a string representation of the ArchNodes instance. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
Parses expressions in the ArchNodes instance. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A collection of architectural nodes.
+This class inherits from ArchNode and ListNode classes.
Attributes: None
+Methods: declare_attrs: Declares attributes for the architectural nodes. init: Initializes an instance of the ArchNodes class. combine: Combines two ArchNodes instances. repr: Returns a string representation of the ArchNodes instance. parse_expressions: Parses expressions in the ArchNodes instance.
| timeloopfe.v4.arch.ArchNodes.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.ArchNode.
+ +| timeloopfe.v4.arch.ArchNodes.__repr__ | +( | +self | ) | ++ |
Returns a string representation of the ArchNodes instance.
Returns: A string representation of the ArchNodes instance.
| "ArchNodes" timeloopfe.v4.arch.ArchNodes.combine | +( | +self, | +|
| + | + | "ArchNodes" | other ) | +
Combines two ArchNodes instances.
Args: other: Another ArchNodes instance to combine with.
Returns: A new ArchNodes instance that is the combination of self and other.
| timeloopfe.v4.arch.ArchNodes.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| timeloopfe.v4.arch.ArchNodes.parse_expressions | +( | +self, | +|
| + | + | Optional[Dict[str, Any]] | symbol_table = None, | +
| + | + | Optional[set] | parsed_ids = None ) | +
Parses expressions in the ArchNodes instance.
Args: symbol_table: A dictionary representing the symbol table. parsed_ids: A set of parsed IDs.
+Returns: The parsed ArchNodes instance.
Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.map
new file mode 100644
index 0000000..a825065
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.md5
new file mode 100644
index 0000000..9436656
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.md5
@@ -0,0 +1 @@
+2b5183050d0598571399db13cd06e918
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.png
new file mode 100644
index 0000000..7633a8d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.map
new file mode 100644
index 0000000..a825065
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.md5
new file mode 100644
index 0000000..9436656
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.md5
@@ -0,0 +1 @@
+2b5183050d0598571399db13cd06e918
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.png
new file mode 100644
index 0000000..7633a8d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1ArchNodes__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture-members.html
new file mode 100644
index 0000000..116ec6a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Architecture, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Architecture) | timeloopfe.v4.arch.Architecture | |
| combine(self, "Architecture" other) | timeloopfe.v4.arch.Architecture | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Architecture |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture.html b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture.html
new file mode 100644
index 0000000..34cf9f0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture.html
@@ -0,0 +1,460 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
An architecture. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| "Architecture" | combine (self, "Architecture" other) |
| Combines this dictionary with another dictionary. | |
| Public Member Functions inherited from timeloopfe.v4.arch.Branch | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in this node and all subnodes. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
An architecture.
+Attributes: version (Union[str, Number]): The version of the architecture.
+| timeloopfe.v4.arch.Architecture.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Branch.
+ +| "Architecture" timeloopfe.v4.arch.Architecture.combine | +( | +self, | +|
| + | + | "Architecture" | other ) | +
Combines this dictionary with another dictionary.
+If a key is present in both dictionaries, the values are combined. Otherwise, the key is taken from whichever dictionary has it.
+ +Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.arch.Architecture.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Branch.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.map
new file mode 100644
index 0000000..6c0baa1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.map
@@ -0,0 +1,19 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.md5
new file mode 100644
index 0000000..05c1db6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.md5
@@ -0,0 +1 @@
+864b632526ee433911ea1abe35f8cbec
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.png
new file mode 100644
index 0000000..42cd1a9
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.map
new file mode 100644
index 0000000..6c0baa1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.map
@@ -0,0 +1,19 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.md5
new file mode 100644
index 0000000..05c1db6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.md5
@@ -0,0 +1 @@
+864b632526ee433911ea1abe35f8cbec
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.png
new file mode 100644
index 0000000..42cd1a9
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Architecture__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes-members.html
new file mode 100644
index 0000000..cefd121
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Attributes, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Attributes) | timeloopfe.v4.arch.Attributes | |
| _default_parse (defined in timeloopfe.v4.arch.Attributes) | timeloopfe.v4.arch.Attributes | protected |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Attributes |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes.html b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes.html
new file mode 100644
index 0000000..e4221d4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes.html
@@ -0,0 +1,418 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A class representing attributes for a node in the architecture. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Protected Attributes | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
A class representing attributes for a node in the architecture.
+Attributes: has_power_gating (bool): Indicates whether the node has power gating.
+| timeloopfe.v4.arch.Attributes.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.arch.Attributes.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +Reimplemented in timeloopfe.v4.arch.StorageAttributes, and timeloopfe.v4.arch.StorageAttributes.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.map
new file mode 100644
index 0000000..efa10cd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.md5
new file mode 100644
index 0000000..07449b7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.md5
@@ -0,0 +1 @@
+bd51f8542f5897c8732814f20b232850
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.png
new file mode 100644
index 0000000..c77a41e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.map
new file mode 100644
index 0000000..d8fab00
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.md5
new file mode 100644
index 0000000..7f810fa
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.md5
@@ -0,0 +1 @@
+e2dc0ca9980889c4deb22c11c19398bc
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.png
new file mode 100644
index 0000000..43da905
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Attributes__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Branch-members.html
new file mode 100644
index 0000000..1aa9c5d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Branch-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Branch, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Branch) | timeloopfe.v4.arch.Branch | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Branch | |
| parse_expressions(self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | timeloopfe.v4.arch.Branch |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch.html b/classtimeloopfe_1_1v4_1_1arch_1_1Branch.html
new file mode 100644
index 0000000..d04d2e5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Branch.html
@@ -0,0 +1,466 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A branch in the architecture. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in this node and all subnodes. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A branch in the architecture.
+Attributes: nodes (ArchNodes): List of child nodes in the branch.
+| timeloopfe.v4.arch.Branch.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.ArchNode.
+ +| timeloopfe.v4.arch.Branch.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +Reimplemented in timeloopfe.v4.arch.Architecture.
+ +| timeloopfe.v4.arch.Branch.parse_expressions | +( | +self, | +|
| + | + | Optional[Dict[str, Any]] | symbol_table = None, | +
| + | + | Optional[set] | parsed_ids = None ) | +
Parse expressions in this node and all subnodes.
+Args: symbol_table: A dictionary mapping variable names to values. parsed_ids: A set of IDs of nodes that have already been parsed. callfunc: A function to call on each node after parsing.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.map
new file mode 100644
index 0000000..736e78b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.map
@@ -0,0 +1,15 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.md5
new file mode 100644
index 0000000..f99bf45
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.md5
@@ -0,0 +1 @@
+ef69fd7d7b8d74d4646b2eaa2b779345
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.png
new file mode 100644
index 0000000..7de73c0
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.map
new file mode 100644
index 0000000..f835fbf
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.map
@@ -0,0 +1,23 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.md5
new file mode 100644
index 0000000..06428c4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.md5
@@ -0,0 +1 @@
+769ccf51813b429fd36e797c13800739
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.png
new file mode 100644
index 0000000..e947c04
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Branch__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Component-members.html
new file mode 100644
index 0000000..1783e37
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Component-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Component, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Component) | timeloopfe.v4.arch.Component | |
| _check_unrecognized(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Component) | timeloopfe.v4.arch.Component | protected |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Component |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component.html b/classtimeloopfe_1_1v4_1_1arch_1_1Component.html
new file mode 100644
index 0000000..5c2daad
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Component.html
@@ -0,0 +1,481 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A component in the architecture. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.arch.Leaf | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse the expressions in the leaf node. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Protected Member Functions | |
| _check_unrecognized (self, *args, **kwargs) | |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A component in the architecture.
+Attributes: _class (str): The class of the component. subclass (str): The subclass of the component. required_actions (List[str]): The list of required actions for the component. area_share (float): The area share of the component. enabled (bool): Indicates whether the component is enabled or not.
+| timeloopfe.v4.arch.Component.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Leaf.
+ +
+
|
+ +protected | +
Reimplemented from timeloopfe.common.nodes.Node.
+ +| timeloopfe.v4.arch.Component.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Leaf.
+ +Reimplemented in timeloopfe.v4.arch.Storage, timeloopfe.v4.arch.Compute, timeloopfe.v4.arch.Network, and timeloopfe.v4.arch.Nothing.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.map
new file mode 100644
index 0000000..4317574
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.map
@@ -0,0 +1,18 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.md5
new file mode 100644
index 0000000..1e76e72
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.md5
@@ -0,0 +1 @@
+efbd926e86781e72b8f6b7ae786f84c8
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.png
new file mode 100644
index 0000000..a61eb20
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Component__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.map
new file mode 100644
index 0000000..1a2db20
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.map
@@ -0,0 +1,26 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.md5
new file mode 100644
index 0000000..1e75a1e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.md5
@@ -0,0 +1 @@
+596404de13c3267194e4c3c318dbf1a7
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.png
new file mode 100644
index 0000000..6be5654
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Component__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Compute-members.html
new file mode 100644
index 0000000..c210719
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Compute-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Compute, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Compute) | timeloopfe.v4.arch.Compute | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Compute |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute.html b/classtimeloopfe_1_1v4_1_1arch_1_1Compute.html
new file mode 100644
index 0000000..45df265
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Compute.html
@@ -0,0 +1,435 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A compute component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.arch.Leaf | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse the expressions in the leaf node. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.v4.arch.Component | |
| _check_unrecognized (self, *args, **kwargs) | |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A compute component.
+| timeloopfe.v4.arch.Compute.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Component.
+ +| timeloopfe.v4.arch.Compute.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Component.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.map
new file mode 100644
index 0000000..75f4e62
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.md5
new file mode 100644
index 0000000..213a4bc
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.md5
@@ -0,0 +1 @@
+80a10786bda14460ec353656eff76a72
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.png
new file mode 100644
index 0000000..e93bb69
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.map
new file mode 100644
index 0000000..75f4e62
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.md5
new file mode 100644
index 0000000..213a4bc
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.md5
@@ -0,0 +1 @@
+80a10786bda14460ec353656eff76a72
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.png
new file mode 100644
index 0000000..e93bb69
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Compute__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Container-members.html
new file mode 100644
index 0000000..03a7870
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Container-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Container, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Container) | timeloopfe.v4.arch.Container | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Container |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container.html b/classtimeloopfe_1_1v4_1_1arch_1_1Container.html
new file mode 100644
index 0000000..cafcf7a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Container.html
@@ -0,0 +1,431 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A container in the architecture. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.arch.Leaf | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse the expressions in the leaf node. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A container in the architecture.
+| timeloopfe.v4.arch.Container.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Leaf.
+ +| timeloopfe.v4.arch.Container.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Leaf.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.map
new file mode 100644
index 0000000..74dd5f4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.map
@@ -0,0 +1,18 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.md5
new file mode 100644
index 0000000..4f52f76
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.md5
@@ -0,0 +1 @@
+7766486924975ae22f562ea87bde4ca0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.png
new file mode 100644
index 0000000..ff9738e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Container__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.map
new file mode 100644
index 0000000..74dd5f4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.map
@@ -0,0 +1,18 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.md5
new file mode 100644
index 0000000..4f52f76
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.md5
@@ -0,0 +1 @@
+7766486924975ae22f562ea87bde4ca0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.png
new file mode 100644
index 0000000..ff9738e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Container__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical.html b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical.html
new file mode 100644
index 0000000..6b4057e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical.html
@@ -0,0 +1,365 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A hierarchical branch in the architecture. + More...
+
+Additional Inherited Members | |
| Public Member Functions inherited from timeloopfe.v4.arch.Branch | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in this node and all subnodes. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A hierarchical branch in the architecture.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.map
new file mode 100644
index 0000000..4993ff1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.map
@@ -0,0 +1,17 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.md5
new file mode 100644
index 0000000..5f9f2ee
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.md5
@@ -0,0 +1 @@
+e39b435a51c3159b7d44e956865e0685
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.png
new file mode 100644
index 0000000..08fcdec
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.map
new file mode 100644
index 0000000..e629e81
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.map
@@ -0,0 +1,19 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.md5
new file mode 100644
index 0000000..d7d4cbd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.md5
@@ -0,0 +1 @@
+1f1fe2480dfd00b2390146af66f6a69f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.png
new file mode 100644
index 0000000..700c6da
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Hierarchical__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf-members.html
new file mode 100644
index 0000000..2e8a19b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Leaf, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Leaf) | timeloopfe.v4.arch.Leaf | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Leaf | |
| parse_expressions(self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | timeloopfe.v4.arch.Leaf |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf.html b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf.html
new file mode 100644
index 0000000..9f0eaac
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf.html
@@ -0,0 +1,471 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A leaf node in the architecture hierarchy. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse the expressions in the leaf node. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A leaf node in the architecture hierarchy.
+Attributes: name (str): The name of the leaf node. attributes (Attributes): The attributes associated with the leaf node. spatial (Spatial): The spatial attributes of the leaf node. constraints (ConstraintGroup): The constraint group associated with the leaf node. sparse_optimizations (SparseOptimizationGroup): The sparse optimization group associated with the leaf node.
+| timeloopfe.v4.arch.Leaf.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.ArchNode.
+ +| timeloopfe.v4.arch.Leaf.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +Reimplemented in timeloopfe.v4.arch.Component, timeloopfe.v4.arch.Container, timeloopfe.v4.arch.Storage, timeloopfe.v4.arch.Compute, timeloopfe.v4.arch.Network, and timeloopfe.v4.arch.Nothing.
+ +| timeloopfe.v4.arch.Leaf.parse_expressions | +( | +self, | +|
| + | + | Optional[Dict[str, Any]] | symbol_table = None, | +
| + | + | Optional[set] | parsed_ids = None ) | +
Parse the expressions in the leaf node.
+Args: symbol_table (Optional[Dict[str, Any]]): The symbol table for parsing expressions. parsed_ids (Optional[set]): The set of parsed IDs.
+Returns: Attributes: The parsed attributes.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.map
new file mode 100644
index 0000000..068d350
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.map
@@ -0,0 +1,15 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.md5
new file mode 100644
index 0000000..15e3159
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.md5
@@ -0,0 +1 @@
+05e76109de202788f125fbe9f0f609e0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.png
new file mode 100644
index 0000000..3ba5dc9
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.map
new file mode 100644
index 0000000..495527c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.map
@@ -0,0 +1,27 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.md5
new file mode 100644
index 0000000..f97898f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.md5
@@ -0,0 +1 @@
+d07807d114f7521082abcaaf6657ab29
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.png
new file mode 100644
index 0000000..67e425a
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Leaf__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Network-members.html
new file mode 100644
index 0000000..e414cab
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Network-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Network, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Network) | timeloopfe.v4.arch.Network | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Network |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network.html b/classtimeloopfe_1_1v4_1_1arch_1_1Network.html
new file mode 100644
index 0000000..23980bb
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Network.html
@@ -0,0 +1,436 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A network component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.arch.Leaf | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse the expressions in the leaf node. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.v4.arch.Component | |
| _check_unrecognized (self, *args, **kwargs) | |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A network component.
+This class inherits from the Component class and provides additional functionality specific to networks.
+| timeloopfe.v4.arch.Network.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Component.
+ +| timeloopfe.v4.arch.Network.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Component.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.map
new file mode 100644
index 0000000..81c365f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.md5
new file mode 100644
index 0000000..993920b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.md5
@@ -0,0 +1 @@
+08c384570521e485b3ad31f03636575f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.png
new file mode 100644
index 0000000..f7463ac
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Network__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.map
new file mode 100644
index 0000000..81c365f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.md5
new file mode 100644
index 0000000..993920b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.md5
@@ -0,0 +1 @@
+08c384570521e485b3ad31f03636575f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.png
new file mode 100644
index 0000000..f7463ac
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Network__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Networks-members.html
new file mode 100644
index 0000000..67b1ca5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Networks-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Networks, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Networks |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks.html b/classtimeloopfe_1_1v4_1_1arch_1_1Networks.html
new file mode 100644
index 0000000..6990f70
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Networks.html
@@ -0,0 +1,324 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of networks in the architecture. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of networks in the architecture.
+| timeloopfe.v4.arch.Networks.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.map
new file mode 100644
index 0000000..0d14635
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.md5
new file mode 100644
index 0000000..3a6e966
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.md5
@@ -0,0 +1 @@
+cf3556e642eaa931eef7979c9b4bdc8c
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.png
new file mode 100644
index 0000000..ee2d568
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.map
new file mode 100644
index 0000000..0d14635
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.md5
new file mode 100644
index 0000000..3a6e966
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.md5
@@ -0,0 +1 @@
+cf3556e642eaa931eef7979c9b4bdc8c
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.png
new file mode 100644
index 0000000..ee2d568
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Networks__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing-members.html
new file mode 100644
index 0000000..73713c4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Nothing, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Nothing) | timeloopfe.v4.arch.Nothing | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Nothing |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing.html b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing.html
new file mode 100644
index 0000000..9170b89
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing.html
@@ -0,0 +1,437 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A class representing a 'nothing' component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.arch.Leaf | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse the expressions in the leaf node. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.v4.arch.Component | |
| _check_unrecognized (self, *args, **kwargs) | |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A class representing a 'nothing' component.
+This class inherits from the Component class and provides a default implementation for the 'nothing' component.
+Attributes: name (str): The name of the component. class (str): The class of the component.
+| timeloopfe.v4.arch.Nothing.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Component.
+ +| timeloopfe.v4.arch.Nothing.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Component.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.map
new file mode 100644
index 0000000..ddc57e6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.md5
new file mode 100644
index 0000000..68cfb3d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.md5
@@ -0,0 +1 @@
+b67a1b62a3158b3fc47c289973be224b
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.png
new file mode 100644
index 0000000..cef0eb6
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.map
new file mode 100644
index 0000000..ddc57e6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.md5
new file mode 100644
index 0000000..68cfb3d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.md5
@@ -0,0 +1 @@
+b67a1b62a3158b3fc47c289973be224b
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.png
new file mode 100644
index 0000000..cef0eb6
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Nothing__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Parallel.html b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel.html
new file mode 100644
index 0000000..344eb19
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel.html
@@ -0,0 +1,363 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A parallel branch in the architecture. + More...
+
+Additional Inherited Members | |
| Public Member Functions inherited from timeloopfe.v4.arch.Branch | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in this node and all subnodes. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A parallel branch in the architecture.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.map
new file mode 100644
index 0000000..80b876f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.map
@@ -0,0 +1,17 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.md5
new file mode 100644
index 0000000..dadebef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.md5
@@ -0,0 +1 @@
+9c147f7b5e51803529f31031477bafe6
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.png
new file mode 100644
index 0000000..a6c94e5
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.map
new file mode 100644
index 0000000..80b876f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.map
@@ -0,0 +1,17 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.md5
new file mode 100644
index 0000000..dadebef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.md5
@@ -0,0 +1 @@
+9c147f7b5e51803529f31031477bafe6
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.png
new file mode 100644
index 0000000..a6c94e5
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Parallel__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined.html b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined.html
new file mode 100644
index 0000000..6615b89
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined.html
@@ -0,0 +1,363 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
" A pipelined branch in the architecture. + More...
+
+Additional Inherited Members | |
| Public Member Functions inherited from timeloopfe.v4.arch.Branch | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in this node and all subnodes. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
" A pipelined branch in the architecture.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.map
new file mode 100644
index 0000000..bca8b76
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.map
@@ -0,0 +1,17 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.md5
new file mode 100644
index 0000000..eb71ccd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.md5
@@ -0,0 +1 @@
+c14513220451fe07a7b6e7c904df2725
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.png
new file mode 100644
index 0000000..924af46
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.map
new file mode 100644
index 0000000..bca8b76
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.map
@@ -0,0 +1,17 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.md5
new file mode 100644
index 0000000..eb71ccd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.md5
@@ -0,0 +1 @@
+c14513220451fe07a7b6e7c904df2725
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.png
new file mode 100644
index 0000000..924af46
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Pipelined__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial-members.html
new file mode 100644
index 0000000..44c7b6e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Spatial, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Spatial) | timeloopfe.v4.arch.Spatial | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Spatial | |
| get_fanout(self) (defined in timeloopfe.v4.arch.Spatial) | timeloopfe.v4.arch.Spatial | |
| to_fanout_string(self) (defined in timeloopfe.v4.arch.Spatial) | timeloopfe.v4.arch.Spatial | |
| validate_fanout(self) (defined in timeloopfe.v4.arch.Spatial) | timeloopfe.v4.arch.Spatial |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial.html b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial.html
new file mode 100644
index 0000000..1e13540
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial.html
@@ -0,0 +1,415 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A spatial configuration in a system architecture. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| + | validate_fanout (self) |
| + | get_fanout (self) |
| + | to_fanout_string (self) |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A spatial configuration in a system architecture.
+Attributes: meshX (int): The number of elements in the X dimension of the mesh. meshY (int): The number of elements in the Y dimension of the mesh. get_fanout (Callable): A function that returns the fanout of the spatial configuration.
+| timeloopfe.v4.arch.Spatial.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.arch.Spatial.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.map
new file mode 100644
index 0000000..2a9081f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.md5
new file mode 100644
index 0000000..703d479
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.md5
@@ -0,0 +1 @@
+5a3896c6c0b9b93f615201ed56bb7b76
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.png
new file mode 100644
index 0000000..ec6565d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.map
new file mode 100644
index 0000000..2a9081f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.md5
new file mode 100644
index 0000000..703d479
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.md5
@@ -0,0 +1 @@
+5a3896c6c0b9b93f615201ed56bb7b76
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.png
new file mode 100644
index 0000000..ec6565d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Spatial__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1Storage-members.html
new file mode 100644
index 0000000..e9d896a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Storage-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.Storage, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.Storage) | timeloopfe.v4.arch.Storage | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.Storage |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage.html b/classtimeloopfe_1_1v4_1_1arch_1_1Storage.html
new file mode 100644
index 0000000..7f8e188
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Storage.html
@@ -0,0 +1,435 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A storage component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.arch.Leaf | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse the expressions in the leaf node. | |
| Public Member Functions inherited from timeloopfe.v4.arch.ArchNode | |
| "Leaf" | name2leaf (self, str name) |
| Finds a leaf node with the given name. | |
| +"Leaf" | find (self, *args, **kwargs) |
| Alias for name2leaf function. | |
| "constraints.ConstraintGroup" | name2constraints (self, str name) |
| Retrieves the constraints of a leaf node with the given name. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Protected Member Functions inherited from timeloopfe.v4.arch.Component | |
| _check_unrecognized (self, *args, **kwargs) | |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
A storage component.
+| timeloopfe.v4.arch.Storage.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Component.
+ +| timeloopfe.v4.arch.Storage.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Component.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes-members.html b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes-members.html
new file mode 100644
index 0000000..bf27d91
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.arch.StorageAttributes, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.StorageAttributes) | timeloopfe.v4.arch.StorageAttributes | |
| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.arch.StorageAttributes) | timeloopfe.v4.arch.StorageAttributes | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.StorageAttributes | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.arch.StorageAttributes |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes.html b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes.html
new file mode 100644
index 0000000..a090d36
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes.html
@@ -0,0 +1,480 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Represents the attributes of a storage element. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.v4.arch.Attributes | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Represents the attributes of a storage element.
+This class provides methods to declare and initialize various attributes related to a storage element, such as datawidth, technology, number of banks, block size, cluster size, etc.
+Attributes: datawidth (Union[str, int]): The datawidth of the storage element. technology (Union[str, int]): The technology used for the storage element. n_banks (Union[str, int]): The number of banks in the storage element. block_size (Union[str, Number]): The block size of the storage element. cluster_size (Union[str, Number]): The cluster size of the storage element. depth (Union[str, Number]): The depth of the storage element. entries (Union[str, Number]): The number of entries in the storage element. sizeKB (Union[str, Number]): The size of the storage element in kilobytes. reduction_supported (Union[str, bool]): Indicates if reduction is supported. multiple_buffering (Union[str, Number]): The level of multiple buffering. min_utilization (Union[str, Number]): The minimum utilization of the storage element. shared_bandwidth (Union[str, Number]): The shared bandwidth of the storage element. read_bandwidth (Union[str, Number]): The read bandwidth of the storage element. write_bandwidth (Union[str, Number]): The write bandwidth of the storage element. network_fill_latency (Union[str, int]): The network fill latency of the storage element. network_drain_latency (Union[str, int]): The network drain latency of the storage element. allow_overbooking (Union[str, bool]): Indicates if overbooking is allowed. metadata_block_size (Union[str, int]): The block size of the metadata storage. metadata_datawidth (Union[str, int]): The datawidth of the metadata storage. metadata_storage_width (Union[str, int]): The storage width of the metadata storage. metadata_storage_depth (Union[str, int]): The storage depth of the metadata storage. concordant_compressed_tile_traversal (Union[str, bool]): Indicates if concordant compressed tile traversal is supported. tile_partition_supported (Union[str, bool]): Indicates if tile partition is supported. decompression_supported (Union[str, bool]): Indicates if decompression is supported. compression_supported (Union[str, bool]): Indicates if compression is supported.
+| timeloopfe.v4.arch.StorageAttributes.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Attributes.
+ +| timeloopfe.v4.arch.StorageAttributes.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.arch.Attributes.
+ +| timeloopfe.v4.arch.StorageAttributes.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Attributes.
+ +| timeloopfe.v4.arch.StorageAttributes.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.arch.Attributes.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.map
new file mode 100644
index 0000000..7bedb0e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.md5
new file mode 100644
index 0000000..d2d4e0a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.md5
@@ -0,0 +1 @@
+0f61ffc8264cb7f0e666690954c5eca9
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.png
new file mode 100644
index 0000000..d492f77
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.map
new file mode 100644
index 0000000..7bedb0e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.md5
new file mode 100644
index 0000000..d2d4e0a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.md5
@@ -0,0 +1 @@
+0f61ffc8264cb7f0e666690954c5eca9
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.png
new file mode 100644
index 0000000..d492f77
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1StorageAttributes__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.map
new file mode 100644
index 0000000..f8ec059
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.md5
new file mode 100644
index 0000000..a9ef4ce
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.md5
@@ -0,0 +1 @@
+90d9305a20e3fde6538d2d50f16c7e3f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.png
new file mode 100644
index 0000000..30a403c
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.map b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.map
new file mode 100644
index 0000000..f8ec059
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.map
@@ -0,0 +1,20 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.md5
new file mode 100644
index 0000000..a9ef4ce
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.md5
@@ -0,0 +1 @@
+90d9305a20e3fde6538d2d50f16c7e3f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.png b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.png
new file mode 100644
index 0000000..30a403c
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1arch_1_1Storage__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action-members.html b/classtimeloopfe_1_1v4_1_1components_1_1Action-members.html
new file mode 100644
index 0000000..762cd7a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Action-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.Action, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.components.Action) | timeloopfe.v4.components.Action | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.Action |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action.html b/classtimeloopfe_1_1v4_1_1components_1_1Action.html
new file mode 100644
index 0000000..6aad502
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Action.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Represents an action that a component can perform. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Represents an action that a component can perform.
+Attributes: name (str): The name of the action. arguments (DictNode): The arguments of the action. subcomponents (ActionSubcomponentsList): The subcomponents of the action.
+| timeloopfe.v4.components.Action.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.components.Action.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList-members.html b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList-members.html
new file mode 100644
index 0000000..7393434
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.ActionSubcomponentsList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.ActionSubcomponentsList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList.html b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList.html
new file mode 100644
index 0000000..15fd662
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList.html
@@ -0,0 +1,324 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of actions that may be taken as subactions of an action. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of actions that may be taken as subactions of an action.
+| timeloopfe.v4.components.ActionSubcomponentsList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.map
new file mode 100644
index 0000000..32bcdc3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.md5
new file mode 100644
index 0000000..a8b8e93
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.md5
@@ -0,0 +1 @@
+06b856e9cea6c0b2f2f7f9c40493f2ec
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.png
new file mode 100644
index 0000000..346fcc5
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.map
new file mode 100644
index 0000000..32bcdc3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.md5
new file mode 100644
index 0000000..a8b8e93
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.md5
@@ -0,0 +1 @@
+06b856e9cea6c0b2f2f7f9c40493f2ec
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.png
new file mode 100644
index 0000000..346fcc5
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ActionSubcomponentsList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.map
new file mode 100644
index 0000000..3f921ef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.md5
new file mode 100644
index 0000000..436e4ab
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.md5
@@ -0,0 +1 @@
+ee882c3d0e3988f34f4b9be5f9b9212f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.png
new file mode 100644
index 0000000..632b255
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1Action__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.map
new file mode 100644
index 0000000..3f921ef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.md5
new file mode 100644
index 0000000..436e4ab
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.md5
@@ -0,0 +1 @@
+ee882c3d0e3988f34f4b9be5f9b9212f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.png
new file mode 100644
index 0000000..632b255
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1Action__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList-members.html b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList-members.html
new file mode 100644
index 0000000..c7325e8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.ActionsList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.ActionsList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList.html b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList.html
new file mode 100644
index 0000000..cd880a3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList.html
@@ -0,0 +1,324 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of actions for a component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of actions for a component.
+| timeloopfe.v4.components.ActionsList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.map
new file mode 100644
index 0000000..0e38dd5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.md5
new file mode 100644
index 0000000..bcf451f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.md5
@@ -0,0 +1 @@
+8efff2fc161386c6ccc6282f0ca069fa
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.png
new file mode 100644
index 0000000..2ba4b62
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.map
new file mode 100644
index 0000000..0e38dd5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.md5
new file mode 100644
index 0000000..bcf451f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.md5
@@ -0,0 +1 @@
+8efff2fc161386c6ccc6282f0ca069fa
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.png
new file mode 100644
index 0000000..2ba4b62
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ActionsList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes-members.html b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes-members.html
new file mode 100644
index 0000000..59a65e8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.ComponentAttributes, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.ComponentAttributes |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes.html b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes.html
new file mode 100644
index 0000000..441628d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes.html
@@ -0,0 +1,376 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Represents the attributes of a component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| __init__ (self, *args, __node_skip_parse=False, **kwargs) | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Represents the attributes of a component.
+| timeloopfe.v4.components.ComponentAttributes.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.map
new file mode 100644
index 0000000..bf379ec
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.md5
new file mode 100644
index 0000000..cadeedb
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.md5
@@ -0,0 +1 @@
+9f8ddc35946b689a485f86f6bad2ca28
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.png
new file mode 100644
index 0000000..478da89
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.map
new file mode 100644
index 0000000..bf379ec
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.md5
new file mode 100644
index 0000000..cadeedb
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.md5
@@ -0,0 +1 @@
+9f8ddc35946b689a485f86f6bad2ca28
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.png
new file mode 100644
index 0000000..478da89
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ComponentAttributes__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components-members.html b/classtimeloopfe_1_1v4_1_1components_1_1Components-members.html
new file mode 100644
index 0000000..584d010
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Components-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.Components, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.components.Components) | timeloopfe.v4.components.Components | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.Components | |
| parse_expressions(self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | timeloopfe.v4.components.Components |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components.html b/classtimeloopfe_1_1v4_1_1components_1_1Components.html
new file mode 100644
index 0000000..9db26f9
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Components.html
@@ -0,0 +1,437 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A collection of components. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in this node and all subnodes. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A collection of components.
+Attributes: version (str): The version of the components. classes (FlatteningListNode): The list of classes associated with the components.
+| timeloopfe.v4.components.Components.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.components.Components.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| timeloopfe.v4.components.Components.parse_expressions | +( | +self, | +|
| + | + | Optional[Dict[str, Any]] | symbol_table = None, | +
| + | + | Optional[set] | parsed_ids = None ) | +
Parse expressions in this node and all subnodes.
+Args: symbol_table: A dictionary mapping variable names to values. parsed_ids: A set of IDs of nodes that have already been parsed. callfunc: A function to call on each node after parsing.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList-members.html b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList-members.html
new file mode 100644
index 0000000..2d840d0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.ComponentsList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.ComponentsList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList.html b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList.html
new file mode 100644
index 0000000..870777e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList.html
@@ -0,0 +1,332 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of components. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.FlatteningListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.FlatteningListNode | |
| + | _flatten (self) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of components.
+| timeloopfe.v4.components.ComponentsList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.map
new file mode 100644
index 0000000..7c8f24e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.md5
new file mode 100644
index 0000000..a65a3eb
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.md5
@@ -0,0 +1 @@
+474e0c094d8ffa006bd3d0d4b99fced2
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.png
new file mode 100644
index 0000000..18a32c2
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.map
new file mode 100644
index 0000000..7c8f24e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.md5
new file mode 100644
index 0000000..a65a3eb
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.md5
@@ -0,0 +1 @@
+474e0c094d8ffa006bd3d0d4b99fced2
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.png
new file mode 100644
index 0000000..18a32c2
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1ComponentsList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.map
new file mode 100644
index 0000000..33f1b17
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.md5
new file mode 100644
index 0000000..a035d4f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.md5
@@ -0,0 +1 @@
+6ada7e9812862b2719c2839e14ea5698
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.png
new file mode 100644
index 0000000..a9cdb04
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1Components__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.map
new file mode 100644
index 0000000..33f1b17
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.md5
new file mode 100644
index 0000000..a035d4f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.md5
@@ -0,0 +1 @@
+6ada7e9812862b2719c2839e14ea5698
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.png
new file mode 100644
index 0000000..a9cdb04
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1Components__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent-members.html b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent-members.html
new file mode 100644
index 0000000..d3ed3be
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.CompoundComponent, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.components.CompoundComponent) | timeloopfe.v4.components.CompoundComponent | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.CompoundComponent |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent.html b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent.html
new file mode 100644
index 0000000..1fc016f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Represents a compound component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Represents a compound component.
+Attributes: name (str): The name of the compound component. attributes (ComponentAttributes): The attributes of the compound component. subcomponents (SubcomponentList): The list of subcomponents. actions (ActionsList): The list of actions.
+| timeloopfe.v4.components.CompoundComponent.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.components.CompoundComponent.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.map
new file mode 100644
index 0000000..d01e6b6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.md5
new file mode 100644
index 0000000..0b9501a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.md5
@@ -0,0 +1 @@
+a68e92f35cf6d7fa3179c87d05fc5538
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.png
new file mode 100644
index 0000000..5f9ff6e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.map
new file mode 100644
index 0000000..d01e6b6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.md5
new file mode 100644
index 0000000..0b9501a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.md5
@@ -0,0 +1 @@
+a68e92f35cf6d7fa3179c87d05fc5538
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.png
new file mode 100644
index 0000000..5f9ff6e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1CompoundComponent__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent-members.html b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent-members.html
new file mode 100644
index 0000000..cc88e4f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.Subcomponent, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.components.Subcomponent) | timeloopfe.v4.components.Subcomponent | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.Subcomponent |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent.html b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent.html
new file mode 100644
index 0000000..d6a69a3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A subcomponent. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A subcomponent.
+Attributes: name (str): The name of the subcomponent. attributes (ComponentAttributes): The attributes of the subcomponent. area_share (Union[Number, str]): The area share of the subcomponent.
+| timeloopfe.v4.components.Subcomponent.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.components.Subcomponent.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction-members.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction-members.html
new file mode 100644
index 0000000..5df959f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.SubcomponentAction, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.components.SubcomponentAction) | timeloopfe.v4.components.SubcomponentAction | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.SubcomponentAction |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction.html
new file mode 100644
index 0000000..0c0fdb5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction.html
@@ -0,0 +1,405 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A subcomponent action. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A subcomponent action.
+| timeloopfe.v4.components.SubcomponentAction.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.components.SubcomponentAction.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup-members.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup-members.html
new file mode 100644
index 0000000..2a77348
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.SubcomponentActionGroup, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.components.SubcomponentActionGroup) | timeloopfe.v4.components.SubcomponentActionGroup | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.SubcomponentActionGroup |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup.html
new file mode 100644
index 0000000..4d71019
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup.html
@@ -0,0 +1,405 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A group of subactions taken by a particular subcomponent. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A group of subactions taken by a particular subcomponent.
+| timeloopfe.v4.components.SubcomponentActionGroup.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.components.SubcomponentActionGroup.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.map
new file mode 100644
index 0000000..fedd946
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.md5
new file mode 100644
index 0000000..333ee3d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.md5
@@ -0,0 +1 @@
+7d1fa557076d12ac892b30be78fbf0f3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.png
new file mode 100644
index 0000000..53df232
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.map
new file mode 100644
index 0000000..fedd946
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.md5
new file mode 100644
index 0000000..333ee3d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.md5
@@ -0,0 +1 @@
+7d1fa557076d12ac892b30be78fbf0f3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.png
new file mode 100644
index 0000000..53df232
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionGroup__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList-members.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList-members.html
new file mode 100644
index 0000000..ccfd18f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.SubcomponentActionList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.SubcomponentActionList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList.html
new file mode 100644
index 0000000..26e34e6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList.html
@@ -0,0 +1,324 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of subcomponent actions. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of subcomponent actions.
+| timeloopfe.v4.components.SubcomponentActionList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.map
new file mode 100644
index 0000000..f197414
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.md5
new file mode 100644
index 0000000..c11b2c9
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.md5
@@ -0,0 +1 @@
+7820687c8cb8f0e56269660539ba073f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.png
new file mode 100644
index 0000000..673961e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.map
new file mode 100644
index 0000000..f197414
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.md5
new file mode 100644
index 0000000..c11b2c9
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.md5
@@ -0,0 +1 @@
+7820687c8cb8f0e56269660539ba073f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.png
new file mode 100644
index 0000000..673961e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentActionList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.map
new file mode 100644
index 0000000..66bd15c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.md5
new file mode 100644
index 0000000..d9495c2
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.md5
@@ -0,0 +1 @@
+5f2c80124d0b445c156da809c014f034
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.png
new file mode 100644
index 0000000..b575b29
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.map
new file mode 100644
index 0000000..66bd15c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.md5
new file mode 100644
index 0000000..d9495c2
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.md5
@@ -0,0 +1 @@
+5f2c80124d0b445c156da809c014f034
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.png
new file mode 100644
index 0000000..b575b29
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentAction__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList-members.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList-members.html
new file mode 100644
index 0000000..ed5226c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.components.SubcomponentList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.components.SubcomponentList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList.html b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList.html
new file mode 100644
index 0000000..cb63fa0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList.html
@@ -0,0 +1,324 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of subcomponents. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of subcomponents.
+| timeloopfe.v4.components.SubcomponentList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.map
new file mode 100644
index 0000000..d01163d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.md5
new file mode 100644
index 0000000..950d684
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.md5
@@ -0,0 +1 @@
+7c239adef392e35049e3c92b01f50c80
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.png
new file mode 100644
index 0000000..06f28de
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.map
new file mode 100644
index 0000000..d01163d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.md5
new file mode 100644
index 0000000..950d684
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.md5
@@ -0,0 +1 @@
+7c239adef392e35049e3c92b01f50c80
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.png
new file mode 100644
index 0000000..06f28de
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1SubcomponentList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.map
new file mode 100644
index 0000000..70d9748
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.md5
new file mode 100644
index 0000000..d13cdc8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.md5
@@ -0,0 +1 @@
+e2d30e6d03cba0b93f33b1dfa022b088
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.png
new file mode 100644
index 0000000..94774ef
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.map b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.map
new file mode 100644
index 0000000..70d9748
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.md5
new file mode 100644
index 0000000..d13cdc8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.md5
@@ -0,0 +1 @@
+e2d30e6d03cba0b93f33b1dfa022b088
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.png b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.png
new file mode 100644
index 0000000..94774ef
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1components_1_1Subcomponent__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint-members.html
new file mode 100644
index 0000000..40480eb
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint-members.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Constraint, including all inherited members.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint.html
new file mode 100644
index 0000000..ecba3b9
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint.html
@@ -0,0 +1,509 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A constraint in the system. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| isempty (self) | |
| Return True if this node is empty. | |
| + | clear_respecification (self, "Constraint" other, dict mine, dict others) |
| +dict | list_attrs_to_dict (self, List[str] attrs) |
| +dict | set_list_attrs_from_dict (self, dict d, Iterable[str] attrs=(), Type cast_to_type=list) |
| +"Constraint" | combine_list_attrs (self, "Constraint" other, List[str] attrs) |
| "Constraint" | combine (self, "Constraint" other) |
| Combines this dictionary with another dictionary. | |
| __str__ (self) | |
| Return the name of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Protected Attributes | |
| + | _disjoint_dataspaces_lists |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
A constraint in the system.
+Args: type (str): The type of the constraint. target (str): The target of the constraint.
+Attributes: type (str): The type of the constraint. target (str): The target of the constraint.
+| timeloopfe.v4.constraints.Constraint.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.constraints.Constraint.__str__ | +( | +self | ) | ++ |
Return the name of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| "Constraint" timeloopfe.v4.constraints.Constraint.combine | +( | +self, | +|
| + | + | "Constraint" | other ) | +
Combines this dictionary with another dictionary.
+If a key is present in both dictionaries, the values are combined. Otherwise, the key is taken from whichever dictionary has it.
+ +Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.constraints.Constraint.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +Reimplemented in timeloopfe.v4.constraints.Iteration, timeloopfe.v4.constraints.Spatial, timeloopfe.v4.constraints.Temporal, timeloopfe.v4.constraints.Dataspace, timeloopfe.v4.constraints.MaxOverbookedProportion, and timeloopfe.v4.constraints.Utilization.
+ +| timeloopfe.v4.constraints.Constraint.isempty | +( | +self | ) | ++ |
Return True if this node is empty.
+Good to override.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup-members.html
new file mode 100644
index 0000000..d03fb84
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.ConstraintGroup, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.ConstraintGroup) | timeloopfe.v4.constraints.ConstraintGroup | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.ConstraintGroup |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup.html b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup.html
new file mode 100644
index 0000000..6a5988a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A group of constraints. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A group of constraints.
+Attributes: spatial (Spatial): The spatial constraint. temporal (Temporal): The temporal constraint. dataspace (Dataspace): The dataspace constraint. max_overbooked_proportion (MaxOverbookedProportion): The maximum overbooked proportion constraint.
+| timeloopfe.v4.constraints.ConstraintGroup.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.constraints.ConstraintGroup.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.map
new file mode 100644
index 0000000..4b7fca1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.md5
new file mode 100644
index 0000000..31f7623
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.md5
@@ -0,0 +1 @@
+a8ff7f848a7a0e16dbab7ab837d0ef97
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.png
new file mode 100644
index 0000000..902c77c
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.map
new file mode 100644
index 0000000..4b7fca1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.md5
new file mode 100644
index 0000000..31f7623
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.md5
@@ -0,0 +1 @@
+a8ff7f848a7a0e16dbab7ab837d0ef97
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.png
new file mode 100644
index 0000000..902c77c
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintGroup__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.map
new file mode 100644
index 0000000..8caa6f0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.md5
new file mode 100644
index 0000000..f0b361b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.md5
@@ -0,0 +1 @@
+3f4615e10afb3754766d97ce9896c43e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.png
new file mode 100644
index 0000000..b6478a3
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.map
new file mode 100644
index 0000000..082781e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.map
@@ -0,0 +1,23 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.md5
new file mode 100644
index 0000000..5e1e80e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.md5
@@ -0,0 +1 @@
+75a5b053bb8e7fdc9582faeca761c80e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.png
new file mode 100644
index 0000000..e256d81
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraint__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints-members.html
new file mode 100644
index 0000000..776f3e4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Constraints, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.Constraints) | timeloopfe.v4.constraints.Constraints | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.Constraints |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints.html
new file mode 100644
index 0000000..2f421e0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Class representing constraints. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Class representing constraints.
+Attributes: version (str): The version of the constraints. targets (ConstraintsList): The list of targets for the constraints.
+| timeloopfe.v4.constraints.Constraints.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.constraints.Constraints.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList-members.html
new file mode 100644
index 0000000..02e2882
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.ConstraintsList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.ConstraintsList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList.html b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList.html
new file mode 100644
index 0000000..94887b7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList.html
@@ -0,0 +1,332 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A class representing a list of constraints. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.CombineableListNode | |
| "CombineableListNode" | combine (self, "CombineableListNode" other) |
| Extends this list with the contents of another list. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A class representing a list of constraints.
+| timeloopfe.v4.constraints.ConstraintsList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.map
new file mode 100644
index 0000000..cf66050
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.md5
new file mode 100644
index 0000000..56924da
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.md5
@@ -0,0 +1 @@
+bcaa8bd6a8f2dadc487b702d72140405
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.png
new file mode 100644
index 0000000..74b2ffa
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.map
new file mode 100644
index 0000000..cf66050
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.md5
new file mode 100644
index 0000000..56924da
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.md5
@@ -0,0 +1 @@
+bcaa8bd6a8f2dadc487b702d72140405
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.png
new file mode 100644
index 0000000..74b2ffa
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1ConstraintsList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.map
new file mode 100644
index 0000000..da65950
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.md5
new file mode 100644
index 0000000..0a567b2
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.md5
@@ -0,0 +1 @@
+98c815a3d1b658e073708a8c4dc25385
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.png
new file mode 100644
index 0000000..3a05f3e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.map
new file mode 100644
index 0000000..da65950
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.md5
new file mode 100644
index 0000000..0a567b2
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.md5
@@ -0,0 +1 @@
+98c815a3d1b658e073708a8c4dc25385
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.png
new file mode 100644
index 0000000..3a05f3e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Constraints__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace-members.html
new file mode 100644
index 0000000..ad91698
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Dataspace, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.Dataspace) | timeloopfe.v4.constraints.Dataspace | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.Dataspace |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace.html
new file mode 100644
index 0000000..127b188
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace.html
@@ -0,0 +1,427 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A constraint class for specifying dataspace properties. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.constraints.Constraint | |
| isempty (self) | |
| Return True if this node is empty. | |
| + | clear_respecification (self, "Constraint" other, dict mine, dict others) |
| +dict | list_attrs_to_dict (self, List[str] attrs) |
| +dict | set_list_attrs_from_dict (self, dict d, Iterable[str] attrs=(), Type cast_to_type=list) |
| +"Constraint" | combine_list_attrs (self, "Constraint" other, List[str] attrs) |
| "Constraint" | combine (self, "Constraint" other) |
| Combines this dictionary with another dictionary. | |
| __str__ (self) | |
| Return the name of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.v4.constraints.Constraint | |
| + | _disjoint_dataspaces_lists |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A constraint class for specifying dataspace properties.
+Attributes: bypass (List[str]): List of bypass dataspace names. keep (List[str]): List of keep dataspace names. no_coalesce (List[str]): List of no_coalesce dataspace names.
+| timeloopfe.v4.constraints.Dataspace.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.constraints.Constraint.
+ +| timeloopfe.v4.constraints.Dataspace.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.constraints.Constraint.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.map
new file mode 100644
index 0000000..a45158b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.md5
new file mode 100644
index 0000000..abad37e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.md5
@@ -0,0 +1 @@
+d24dd2dc4d38ee8d49f17c0400c1009d
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.png
new file mode 100644
index 0000000..2e06474
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.map
new file mode 100644
index 0000000..a45158b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.md5
new file mode 100644
index 0000000..abad37e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.md5
@@ -0,0 +1 @@
+d24dd2dc4d38ee8d49f17c0400c1009d
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.png
new file mode 100644
index 0000000..2e06474
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Dataspace__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factor.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor.html
new file mode 100644
index 0000000..6a6ff55
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor.html
@@ -0,0 +1,115 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A loop factor (e.g., P=1) + More...
+
A loop factor (e.g., P=1)
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.map
new file mode 100644
index 0000000..452c10b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.md5
new file mode 100644
index 0000000..348da51
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.md5
@@ -0,0 +1 @@
+0890aac938f82306732e4a8348d1e0d6
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.png
new file mode 100644
index 0000000..d1ba64b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.map
new file mode 100644
index 0000000..452c10b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.md5
new file mode 100644
index 0000000..348da51
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.md5
@@ -0,0 +1 @@
+0890aac938f82306732e4a8348d1e0d6
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.png
new file mode 100644
index 0000000..d1ba64b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Factor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors-members.html
new file mode 100644
index 0000000..469a9cd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors-members.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Factors, including all inherited members.
+ 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors.html
new file mode 100644
index 0000000..2926682
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors.html
@@ -0,0 +1,793 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of factors used to describe loop bounds. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| List[Tuple[str, str, str]] | get_split_factors (self) |
| Get a list of split factors. | |
| List[str] | get_factor_names (self) |
| Get a list of factor names. | |
| remove_factor (self, str name) | |
| Remove a factor from the list of factors. | |
| add_eq_factor (self, str name, int value, bool overwrite=False) | |
| Adds an equality factor to the constraint. | |
| add_leq_factor (self, str name, int value, bool overwrite=False) | |
| Adds a less than or equal to (<=) factor constraint to the list of constraints. | |
| add_geq_factor (self, str name, int value, bool overwrite=False) | |
| Adds a greater-than-or-equal factor constraint to the constraint set. | |
| + | check_unique_remove_repeat (self) |
| "Factors" | combine (self, "Factors" other) |
| Extends this list with the contents of another list. | |
| get_minimum_product (self, problem.Instance problem_instance) | |
| Calculates the minimum product of all factors in this list. | |
| bool | add_eq_factor_iff_not_exists (self, str name, int value) |
| Add an "name=value" factor iff "name" is not already in the factor list. | |
| bool | add_leq_factor_iff_not_exists (self, str name, int value) |
| Add an "name<=value" factor iff "name" is not already in the factor list. | |
| +Optional[str] | name2factor (self, str name) |
| Return the factor with the given name, or None if not found. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Static Public Member Functions | |
| check_valid_factor (f, bool _allow_invalid=True) | |
| Check if a factor is valid. | |
| "Factors" | factory (Union[str, list] x) |
| Create a Factors object from a string or a list. | |
| Tuple[str, str, int] | splitfactor (str x) |
| Split a factor string into its components. | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
+Protected Member Functions | |
| + | _check_factors_compatible (self, a, b) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of factors used to describe loop bounds.
+| timeloopfe.v4.constraints.Factors.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ +| timeloopfe.v4.constraints.Factors.add_eq_factor | +( | +self, | +|
| + | + | str | name, | +
| + | + | int | value, | +
| + | + | bool | overwrite = False ) | +
Adds an equality factor to the constraint.
+Args: name (str): The name of the factor. value (int): The value of the factor. overwrite (bool, optional): If True, removes any existing factor with the same name before adding the new one. Defaults to False.
+ +| bool timeloopfe.v4.constraints.Factors.add_eq_factor_iff_not_exists | +( | +self, | +|
| + | + | str | name, | +
| + | + | int | value ) | +
Add an "name=value" factor iff "name" is not already in the factor list.
+Return True if the factor was added.
+ +| timeloopfe.v4.constraints.Factors.add_geq_factor | +( | +self, | +|
| + | + | str | name, | +
| + | + | int | value, | +
| + | + | bool | overwrite = False ) | +
Adds a greater-than-or-equal factor constraint to the constraint set.
+Args: name (str): The name of the factor. value (int): The value of the factor. overwrite (bool, optional): If True, removes any existing factor with the same name before adding the new one. Defaults to False.
+ +| timeloopfe.v4.constraints.Factors.add_leq_factor | +( | +self, | +|
| + | + | str | name, | +
| + | + | int | value, | +
| + | + | bool | overwrite = False ) | +
Adds a less than or equal to (<=) factor constraint to the list of constraints.
+Args: name (str): The name of the factor. value (int): The value of the factor. overwrite (bool, optional): If True, removes any existing factor with the same name before adding the new one. Defaults to False.
+ +| bool timeloopfe.v4.constraints.Factors.add_leq_factor_iff_not_exists | +( | +self, | +|
| + | + | str | name, | +
| + | + | int | value ) | +
Add an "name<=value" factor iff "name" is not already in the factor list.
+Return True if the factor was added.
+ +
+
|
+ +static | +
Check if a factor is valid.
+Parameters:
Returns:
Raises:
| "Factors" timeloopfe.v4.constraints.Factors.combine | +( | +self, | +|
| + | + | "Factors" | other ) | +
Extends this list with the contents of another list.
+ +Reimplemented from timeloopfe.common.nodes.CombineableListNode.
+ +| timeloopfe.v4.constraints.Factors.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +
+
|
+ +static | +
Create a Factors object from a string or a list.
+Args: x (Union[str, list]): The input string or list.
+Returns: Factors: The Factors object created from the input.
+Raises: None
+ +| List[str] timeloopfe.v4.constraints.Factors.get_factor_names | +( | +self | ) | ++ |
Get a list of factor names.
+Example: get_factor_names() returns ["X", "Y", "Z"] if the factors are "X=123", "Y=456", and "Z=789".
+ +| timeloopfe.v4.constraints.Factors.get_minimum_product | +( | +self, | +|
| + | + | problem.Instance | problem_instance ) | +
Calculates the minimum product of all factors in this list.
+Args: problem_instance (problem.Instance): The problem instance.
+Returns: int: The calculated minimum product.
+ +| List[Tuple[str, str, str]] timeloopfe.v4.constraints.Factors.get_split_factors | +( | +self | ) | ++ |
Get a list of split factors.
+Example: get_split_factors() returns [("X", "=", "123"), ("Y", "=", "456"), ("Z", "=", "789")] if the factors are "X=123", "Y=456", and "Z=789".
+ +| timeloopfe.v4.constraints.Factors.remove_factor | +( | +self, | +|
| + | + | str | name ) | +
Remove a factor from the list of factors.
+Args: name (str): The name of the factor to be removed.
+Raises: None
+Example: remove_factor("X") removes the factor "X=123" from the list of factors.
+ +
+
|
+ +static | +
Split a factor string into its components.
+Args: x (str): The factor string to be split.
+Returns: Tuple[str, str, int]: A tuple containing the factor name, the comparison operator, and the factor value.
+Raises: ValueError: If none of the valid comparison operators are found in the factor string.
+Example: splitfactor("X=123") returns ("X", "=", 123)
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.map
new file mode 100644
index 0000000..04dfaa2
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.md5
new file mode 100644
index 0000000..51fab4d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.md5
@@ -0,0 +1 @@
+ae60093f5e12f27be5925331a060ad31
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.png
new file mode 100644
index 0000000..d2f2270
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.map
new file mode 100644
index 0000000..04dfaa2
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.md5
new file mode 100644
index 0000000..51fab4d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.md5
@@ -0,0 +1 @@
+ae60093f5e12f27be5925331a060ad31
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.png
new file mode 100644
index 0000000..d2f2270
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Factors__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration-members.html
new file mode 100644
index 0000000..b4f4a1c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Iteration, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.Iteration) | timeloopfe.v4.constraints.Iteration | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.Iteration |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration.html
new file mode 100644
index 0000000..45d9315
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration.html
@@ -0,0 +1,433 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
An iteration (spatial or temporal) constraint. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.constraints.Constraint | |
| isempty (self) | |
| Return True if this node is empty. | |
| + | clear_respecification (self, "Constraint" other, dict mine, dict others) |
| +dict | list_attrs_to_dict (self, List[str] attrs) |
| +dict | set_list_attrs_from_dict (self, dict d, Iterable[str] attrs=(), Type cast_to_type=list) |
| +"Constraint" | combine_list_attrs (self, "Constraint" other, List[str] attrs) |
| "Constraint" | combine (self, "Constraint" other) |
| Combines this dictionary with another dictionary. | |
| __str__ (self) | |
| Return the name of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.v4.constraints.Constraint | |
| + | _disjoint_dataspaces_lists |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
An iteration (spatial or temporal) constraint.
+Attributes: factors (Factors): The factors associated with the iteration. permutation (Permutation): The permutation associated with the iteration. default_max_factor (int): The default maximum factor value. default_min_factor (int): The default minimum factor value. remainders (int): The remainders associated with the iteration.
+| timeloopfe.v4.constraints.Iteration.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.constraints.Constraint.
+ +| timeloopfe.v4.constraints.Iteration.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.constraints.Constraint.
+ +Reimplemented in timeloopfe.v4.constraints.Spatial, and timeloopfe.v4.constraints.Temporal.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.map
new file mode 100644
index 0000000..d40c951
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.md5
new file mode 100644
index 0000000..28b2c3e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.md5
@@ -0,0 +1 @@
+663338323a866772f6fcc2dd37fc1ec1
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.png
new file mode 100644
index 0000000..cb698c8
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.map
new file mode 100644
index 0000000..381b43c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.map
@@ -0,0 +1,17 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.md5
new file mode 100644
index 0000000..a24c581
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.md5
@@ -0,0 +1 @@
+ad347d5fe245d3dab89b8a222700c2dc
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.png
new file mode 100644
index 0000000..6ea2aba
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Iteration__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion-members.html
new file mode 100644
index 0000000..f813e0b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.MaxOverbookedProportion, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.MaxOverbookedProportion) | timeloopfe.v4.constraints.MaxOverbookedProportion | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.MaxOverbookedProportion |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion.html b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion.html
new file mode 100644
index 0000000..915c680
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion.html
@@ -0,0 +1,427 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A constraint that defines the maximum overbooked proportion. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.constraints.Constraint | |
| isempty (self) | |
| Return True if this node is empty. | |
| + | clear_respecification (self, "Constraint" other, dict mine, dict others) |
| +dict | list_attrs_to_dict (self, List[str] attrs) |
| +dict | set_list_attrs_from_dict (self, dict d, Iterable[str] attrs=(), Type cast_to_type=list) |
| +"Constraint" | combine_list_attrs (self, "Constraint" other, List[str] attrs) |
| "Constraint" | combine (self, "Constraint" other) |
| Combines this dictionary with another dictionary. | |
| __str__ (self) | |
| Return the name of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.v4.constraints.Constraint | |
| + | _disjoint_dataspaces_lists |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A constraint that defines the maximum overbooked proportion.
+Attributes: proportion (float): The maximum overbooked proportion.
+| timeloopfe.v4.constraints.MaxOverbookedProportion.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.constraints.Constraint.
+ +| timeloopfe.v4.constraints.MaxOverbookedProportion.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.constraints.Constraint.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.map
new file mode 100644
index 0000000..f924d16
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.md5
new file mode 100644
index 0000000..5188b8c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.md5
@@ -0,0 +1 @@
+20ac7af298fec70ac6065394f7caf018
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.png
new file mode 100644
index 0000000..c954f18
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.map
new file mode 100644
index 0000000..f924d16
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.md5
new file mode 100644
index 0000000..5188b8c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.md5
@@ -0,0 +1 @@
+20ac7af298fec70ac6065394f7caf018
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.png
new file mode 100644
index 0000000..c954f18
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1MaxOverbookedProportion__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation-members.html
new file mode 100644
index 0000000..9c013ec
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Permutation, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.Permutation | |
| factory(Union[str, list] x) (defined in timeloopfe.v4.constraints.Permutation) | timeloopfe.v4.constraints.Permutation | static |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation.html
new file mode 100644
index 0000000..28dc67e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation.html
@@ -0,0 +1,331 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A permutation of ranks. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Static Public Member Functions | |
| +"Permutation" | factory (Union[str, list] x) |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A permutation of ranks.
+| timeloopfe.v4.constraints.Permutation.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.map
new file mode 100644
index 0000000..18c1515
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.md5
new file mode 100644
index 0000000..3f21c76
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.md5
@@ -0,0 +1 @@
+d3f1509c7fc432da48ffeeb4e1ed3fc1
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.png
new file mode 100644
index 0000000..d0c8f7c
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.map
new file mode 100644
index 0000000..18c1515
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.md5
new file mode 100644
index 0000000..3f21c76
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.md5
@@ -0,0 +1 @@
+d3f1509c7fc432da48ffeeb4e1ed3fc1
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.png
new file mode 100644
index 0000000..d0c8f7c
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Permutation__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList-members.html
new file mode 100644
index 0000000..3ceaa60
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.ProblemDataspaceList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.ProblemDataspaceList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList.html b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList.html
new file mode 100644
index 0000000..3f1045e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList.html
@@ -0,0 +1,324 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of problem dataspaces. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of problem dataspaces.
+| timeloopfe.v4.constraints.ProblemDataspaceList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.map
new file mode 100644
index 0000000..95b3e80
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.md5
new file mode 100644
index 0000000..c02c856
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.md5
@@ -0,0 +1 @@
+116684cdfbaf73e6ecbb91ffa9ed9452
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.png
new file mode 100644
index 0000000..f573415
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.map
new file mode 100644
index 0000000..95b3e80
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.md5
new file mode 100644
index 0000000..c02c856
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.md5
@@ -0,0 +1 @@
+116684cdfbaf73e6ecbb91ffa9ed9452
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.png
new file mode 100644
index 0000000..f573415
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1ProblemDataspaceList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial-members.html
new file mode 100644
index 0000000..2b68249
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Spatial, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.Spatial) | timeloopfe.v4.constraints.Spatial | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.Spatial |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial.html
new file mode 100644
index 0000000..7568e3a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial.html
@@ -0,0 +1,431 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A spatial iteration constraint. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.constraints.Constraint | |
| isempty (self) | |
| Return True if this node is empty. | |
| + | clear_respecification (self, "Constraint" other, dict mine, dict others) |
| +dict | list_attrs_to_dict (self, List[str] attrs) |
| +dict | set_list_attrs_from_dict (self, dict d, Iterable[str] attrs=(), Type cast_to_type=list) |
| +"Constraint" | combine_list_attrs (self, "Constraint" other, List[str] attrs) |
| "Constraint" | combine (self, "Constraint" other) |
| Combines this dictionary with another dictionary. | |
| __str__ (self) | |
| Return the name of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.v4.constraints.Constraint | |
| + | _disjoint_dataspaces_lists |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A spatial iteration constraint.
+Attributes: no_reuse (List[str]): A list of problem dataspaces that should not be reused. no_link_transfer (List[str]): A list of problem dataspaces that should not have link transfers. split (int): The number of splits for the spatial iteration.
+| timeloopfe.v4.constraints.Spatial.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.constraints.Iteration.
+ +| timeloopfe.v4.constraints.Spatial.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.constraints.Iteration.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.map
new file mode 100644
index 0000000..af2a43d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.map
@@ -0,0 +1,15 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.md5
new file mode 100644
index 0000000..a417002
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.md5
@@ -0,0 +1 @@
+13253cc61a4a5fefa35ed1ad83ef9c04
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.png
new file mode 100644
index 0000000..2a78ac1
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.map
new file mode 100644
index 0000000..af2a43d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.map
@@ -0,0 +1,15 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.md5
new file mode 100644
index 0000000..a417002
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.md5
@@ -0,0 +1 @@
+13253cc61a4a5fefa35ed1ad83ef9c04
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.png
new file mode 100644
index 0000000..2a78ac1
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Spatial__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal-members.html
new file mode 100644
index 0000000..b115f70
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Temporal, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.Temporal) | timeloopfe.v4.constraints.Temporal | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.Temporal |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal.html
new file mode 100644
index 0000000..f5f6139
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal.html
@@ -0,0 +1,431 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A temporal iteration constraint. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.constraints.Constraint | |
| isempty (self) | |
| Return True if this node is empty. | |
| + | clear_respecification (self, "Constraint" other, dict mine, dict others) |
| +dict | list_attrs_to_dict (self, List[str] attrs) |
| +dict | set_list_attrs_from_dict (self, dict d, Iterable[str] attrs=(), Type cast_to_type=list) |
| +"Constraint" | combine_list_attrs (self, "Constraint" other, List[str] attrs) |
| "Constraint" | combine (self, "Constraint" other) |
| Combines this dictionary with another dictionary. | |
| __str__ (self) | |
| Return the name of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.v4.constraints.Constraint | |
| + | _disjoint_dataspaces_lists |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A temporal iteration constraint.
+Attributes: no_reuse (List[str]): A list of problem dataspaces that should not be reused. rmw_first_update (List[str]): A list of problem dataspaces that should have RMW for the first update (rather than a write only).
+| timeloopfe.v4.constraints.Temporal.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.constraints.Iteration.
+ +| timeloopfe.v4.constraints.Temporal.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.constraints.Iteration.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.map
new file mode 100644
index 0000000..fd09e09
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.map
@@ -0,0 +1,15 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.md5
new file mode 100644
index 0000000..ec22d19
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.md5
@@ -0,0 +1 @@
+a199aa5b79af57aea84ea3e0ae9eafba
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.png
new file mode 100644
index 0000000..8a4753f
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.map
new file mode 100644
index 0000000..fd09e09
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.map
@@ -0,0 +1,15 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.md5
new file mode 100644
index 0000000..ec22d19
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.md5
@@ -0,0 +1 @@
+a199aa5b79af57aea84ea3e0ae9eafba
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.png
new file mode 100644
index 0000000..8a4753f
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Temporal__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization-members.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization-members.html
new file mode 100644
index 0000000..56f0722
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.constraints.Utilization, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.constraints.Utilization) | timeloopfe.v4.constraints.Utilization | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.constraints.Utilization |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization.html b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization.html
new file mode 100644
index 0000000..8ba39b9
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization.html
@@ -0,0 +1,427 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A constraint that defines the utilization of a component. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.v4.constraints.Constraint | |
| isempty (self) | |
| Return True if this node is empty. | |
| + | clear_respecification (self, "Constraint" other, dict mine, dict others) |
| +dict | list_attrs_to_dict (self, List[str] attrs) |
| +dict | set_list_attrs_from_dict (self, dict d, Iterable[str] attrs=(), Type cast_to_type=list) |
| +"Constraint" | combine_list_attrs (self, "Constraint" other, List[str] attrs) |
| "Constraint" | combine (self, "Constraint" other) |
| Combines this dictionary with another dictionary. | |
| __str__ (self) | |
| Return the name of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.v4.constraints.Constraint | |
| + | _disjoint_dataspaces_lists |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A constraint that defines the utilization of a component.
+Attributes: min (float or str): The minimum utilization value. type (str): The type of the constraint, which is "utilization".
+| timeloopfe.v4.constraints.Utilization.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.v4.constraints.Constraint.
+ +| timeloopfe.v4.constraints.Utilization.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.v4.constraints.Constraint.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.map
new file mode 100644
index 0000000..369cf87
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.md5
new file mode 100644
index 0000000..b4e046b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.md5
@@ -0,0 +1 @@
+a7157f80eda80b323740cefa61dbe8e1
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.png
new file mode 100644
index 0000000..b6f1c8f
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.map b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.map
new file mode 100644
index 0000000..369cf87
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.md5
new file mode 100644
index 0000000..b4e046b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.md5
@@ -0,0 +1 @@
+a7157f80eda80b323740cefa61dbe8e1
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.png b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.png
new file mode 100644
index 0000000..b6f1c8f
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1constraints_1_1Utilization__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables-members.html b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables-members.html
new file mode 100644
index 0000000..a0b14ef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.globals.EnvironmentVariables, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.globals.EnvironmentVariables) | timeloopfe.v4.globals.EnvironmentVariables | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.globals.EnvironmentVariables |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables.html b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables.html
new file mode 100644
index 0000000..443c04d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables.html
@@ -0,0 +1,405 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Dictionary of environment variables. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Dictionary of environment variables.
+| timeloopfe.v4.globals.EnvironmentVariables.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.globals.EnvironmentVariables.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.map b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.map
new file mode 100644
index 0000000..0aeaa1a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.md5
new file mode 100644
index 0000000..9a8503e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.md5
@@ -0,0 +1 @@
+ea02d9ac7c60005decf3fa59c5c7c364
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.png b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.png
new file mode 100644
index 0000000..758c82a
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.map b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.map
new file mode 100644
index 0000000..0aeaa1a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.md5
new file mode 100644
index 0000000..9a8503e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.md5
@@ -0,0 +1 @@
+ea02d9ac7c60005decf3fa59c5c7c364
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.png b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.png
new file mode 100644
index 0000000..758c82a
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1globals_1_1EnvironmentVariables__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions-members.html b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions-members.html
new file mode 100644
index 0000000..09098cb
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.globals.ExpressionCustomFunctions, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.globals.ExpressionCustomFunctions) | timeloopfe.v4.globals.ExpressionCustomFunctions | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.globals.ExpressionCustomFunctions |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions.html b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions.html
new file mode 100644
index 0000000..652cda5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions.html
@@ -0,0 +1,360 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of paths to Python files containing functions to be used in expressions. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.CombineableListNode | |
| "CombineableListNode" | combine (self, "CombineableListNode" other) |
| Extends this list with the contents of another list. | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of paths to Python files containing functions to be used in expressions.
+| timeloopfe.v4.globals.ExpressionCustomFunctions.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ +| timeloopfe.v4.globals.ExpressionCustomFunctions.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.map b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.map
new file mode 100644
index 0000000..058b25d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.md5
new file mode 100644
index 0000000..4b175d7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.md5
@@ -0,0 +1 @@
+2acbcc8b9f1ebf9216fcd20d6c2402c0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.png b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.png
new file mode 100644
index 0000000..c48e48d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.map b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.map
new file mode 100644
index 0000000..058b25d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.map
@@ -0,0 +1,13 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.md5
new file mode 100644
index 0000000..4b175d7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.md5
@@ -0,0 +1 @@
+2acbcc8b9f1ebf9216fcd20d6c2402c0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.png b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.png
new file mode 100644
index 0000000..c48e48d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1globals_1_1ExpressionCustomFunctions__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals-members.html b/classtimeloopfe_1_1v4_1_1globals_1_1Globals-members.html
new file mode 100644
index 0000000..36bdaa9
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1Globals-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.globals.Globals, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.globals.Globals) | timeloopfe.v4.globals.Globals | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.globals.Globals |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals.html b/classtimeloopfe_1_1v4_1_1globals_1_1Globals.html
new file mode 100644
index 0000000..49fc47d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1Globals.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Top-level Globals key. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Top-level Globals key.
+Attributes: version (str): Version of the Timeloop file. environment_variables (EnvironmentVariables): Environment variables to be used. expression_custom_functions (ExpressionCustomFunctions): Paths to Python files containing functions to be used in expressions.
+| timeloopfe.v4.globals.Globals.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.globals.Globals.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.map b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.map
new file mode 100644
index 0000000..e8dc336
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.md5
new file mode 100644
index 0000000..7f51e3b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.md5
@@ -0,0 +1 @@
+10dc35fe457ab39030a5425f3aae5ca0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.png b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.png
new file mode 100644
index 0000000..4105924
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.map b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.map
new file mode 100644
index 0000000..e8dc336
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.md5
new file mode 100644
index 0000000..7f51e3b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.md5
@@ -0,0 +1 @@
+10dc35fe457ab39030a5425f3aae5ca0
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.png b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.png
new file mode 100644
index 0000000..4105924
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1globals_1_1Globals__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper-members.html b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper-members.html
new file mode 100644
index 0000000..9e6c125
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.mapper.Mapper, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.mapper.Mapper) | timeloopfe.v4.mapper.Mapper | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.mapper.Mapper |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper.html b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper.html
new file mode 100644
index 0000000..e082205
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A mapper object that holds various attributes and settings for mapping operations in Timeloop. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A mapper object that holds various attributes and settings for mapping operations in Timeloop.
+Attributes: version (str): The version of the mapper. out_prefix (str): The prefix for output files generated by the mapper. num_threads (int): The number of threads to use for mapping. optimization_metric (OptimizationMetrics): The optimization metric to use for mapping. search_size (int): The size of the search space for mapping. timeout (int): The timeout value for mapping operations. victory_condition (int): The victory condition for mapping. sync_interval (int): The synchronization interval for mapping. log_interval (int): The interval for logging mapping information. log_oaves (bool): Flag indicating whether to log OAVEs (Overall Average Energy). log_oaves_mappings (bool): Flag indicating whether to log OAVEs for each mapping. log_stats (bool): Flag indicating whether to log mapping statistics. log_suboptimal (bool): Flag indicating whether to log suboptimal mappings. live_status (bool): Flag indicating whether to display live mapping status. diagnostics (bool): Flag indicating whether to enable mapping diagnostics. penalize_consecutive_bypass_fails (bool): Flag indicating whether to penalize consecutive bypass fails. emit_whoop_nest (bool): Flag indicating whether to emit the Whoop nest. algorithm (str): The mapping algorithm to use. filter_revisits (bool): Flag indicating whether to filter revisited mappings. max_permutations_per_if_visit (int): The maximum number of permutations per index factorization visit.
+| timeloopfe.v4.mapper.Mapper.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.mapper.Mapper.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.map b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.map
new file mode 100644
index 0000000..f012ef6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.md5
new file mode 100644
index 0000000..97b2562
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.md5
@@ -0,0 +1 @@
+ba707655972b0c45c8f3449023774422
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.png b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.png
new file mode 100644
index 0000000..1e7ea63
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.map b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.map
new file mode 100644
index 0000000..f012ef6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.md5
new file mode 100644
index 0000000..97b2562
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.md5
@@ -0,0 +1 @@
+ba707655972b0c45c8f3449023774422
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.png b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.png
new file mode 100644
index 0000000..1e7ea63
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1mapper_1_1Mapper__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics-members.html b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics-members.html
new file mode 100644
index 0000000..c57121f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.mapper.OptimizationMetrics, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.mapper.OptimizationMetrics) | timeloopfe.v4.mapper.OptimizationMetrics | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.mapper.OptimizationMetrics |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics.html b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics.html
new file mode 100644
index 0000000..74a73f1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics.html
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of optimization metrics including delay, energy, EDP, and last level accesses. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of optimization metrics including delay, energy, EDP, and last level accesses.
+| timeloopfe.v4.mapper.OptimizationMetrics.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ +| timeloopfe.v4.mapper.OptimizationMetrics.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.map b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.map
new file mode 100644
index 0000000..ad5ae78
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.md5
new file mode 100644
index 0000000..d71bb17
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.md5
@@ -0,0 +1 @@
+62629ba8efe874c7bc3183a870db7a6e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.png b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.png
new file mode 100644
index 0000000..419d4aa
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.map b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.map
new file mode 100644
index 0000000..ad5ae78
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.md5
new file mode 100644
index 0000000..d71bb17
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.md5
@@ -0,0 +1 @@
+62629ba8efe874c7bc3183a870db7a6e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.png b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.png
new file mode 100644
index 0000000..419d4aa
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1mapper_1_1OptimizationMetrics__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace-members.html b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace-members.html
new file mode 100644
index 0000000..28508d1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.mapspace.Mapspace, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.mapspace.Mapspace) | timeloopfe.v4.mapspace.Mapspace | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.mapspace.Mapspace |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace.html b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace.html
new file mode 100644
index 0000000..b174ff7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Top-level mapspace object. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Top-level mapspace object.
+Attributes: version (str): The version of the mapspace. template (str): The template to use for the mapspace. "ruby" for imperfect factorization, any other string for perfect factorization.
+| timeloopfe.v4.mapspace.Mapspace.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.mapspace.Mapspace.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.map b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.map
new file mode 100644
index 0000000..c980bef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.md5
new file mode 100644
index 0000000..aeab5cd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.md5
@@ -0,0 +1 @@
+b2a08ff82c6b9f337a59f6e46658e7b3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.png b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.png
new file mode 100644
index 0000000..de66c35
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.map b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.map
new file mode 100644
index 0000000..c980bef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.md5
new file mode 100644
index 0000000..aeab5cd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.md5
@@ -0,0 +1 @@
+b2a08ff82c6b9f337a59f6e46658e7b3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.png b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.png
new file mode 100644
index 0000000..de66c35
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1mapspace_1_1Mapspace__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace-members.html b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace-members.html
new file mode 100644
index 0000000..a5dbcdf
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.problem.DataSpace, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.problem.DataSpace) | timeloopfe.v4.problem.DataSpace | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.problem.DataSpace |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace.html b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace.html
new file mode 100644
index 0000000..e777b28
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A data space object. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A data space object.
+Attributes: name (str): The name of the data space. projection (list): The projection of the data space. read_write (str, bool, int): The read-write attribute of the data space. factors (list): The factors derived from the projection.
+| timeloopfe.v4.problem.DataSpace.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.problem.DataSpace.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.map
new file mode 100644
index 0000000..0ce04c6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.md5
new file mode 100644
index 0000000..97c06b7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.md5
@@ -0,0 +1 @@
+b88a6058d30a52945ee55abec71b5d25
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.png
new file mode 100644
index 0000000..13a591d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.map
new file mode 100644
index 0000000..0ce04c6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.md5
new file mode 100644
index 0000000..97c06b7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.md5
@@ -0,0 +1 @@
+b88a6058d30a52945ee55abec71b5d25
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.png
new file mode 100644
index 0000000..13a591d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1DataSpace__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density-members.html b/classtimeloopfe_1_1v4_1_1problem_1_1Density-members.html
new file mode 100644
index 0000000..0df938b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Density-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.problem.Density, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.problem.Density) | timeloopfe.v4.problem.Density | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.problem.Density |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density.html b/classtimeloopfe_1_1v4_1_1problem_1_1Density.html
new file mode 100644
index 0000000..e6f6b43
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Density.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A Density object represents the density and distribution of a workload tensor. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A Density object represents the density and distribution of a workload tensor.
+Attributes: density (Number or str): The density of the workload tensor. distribution (str): The distribution type of the workload tensor. band_width (int): The band width of the workload tensor (for banded distribution). workload_tensor_size (int): The size of the workload tensor (for hypergeometric distribution).
+| timeloopfe.v4.problem.Density.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.problem.Density.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList-members.html b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList-members.html
new file mode 100644
index 0000000..c2cf6e1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.problem.DensityList, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.problem.DensityList) | timeloopfe.v4.problem.DensityList | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.problem.DensityList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList.html b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList.html
new file mode 100644
index 0000000..aa3c203
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList.html
@@ -0,0 +1,405 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of densities for each data space. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of densities for each data space.
+| timeloopfe.v4.problem.DensityList.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.problem.DensityList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.map
new file mode 100644
index 0000000..ba809e1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.md5
new file mode 100644
index 0000000..888ab70
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.md5
@@ -0,0 +1 @@
+19b7a32d00bdb5de64d75d9e44951f26
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.png
new file mode 100644
index 0000000..9348ba7
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.map
new file mode 100644
index 0000000..ba809e1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.md5
new file mode 100644
index 0000000..888ab70
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.md5
@@ -0,0 +1 @@
+19b7a32d00bdb5de64d75d9e44951f26
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.png
new file mode 100644
index 0000000..9348ba7
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1DensityList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.map
new file mode 100644
index 0000000..1e86ee7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.md5
new file mode 100644
index 0000000..3766bf0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.md5
@@ -0,0 +1 @@
+b2ef15d2af63854ee9dfdaa3978cf3eb
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.png
new file mode 100644
index 0000000..4539a44
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Density__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.map
new file mode 100644
index 0000000..1e86ee7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.md5
new file mode 100644
index 0000000..3766bf0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.md5
@@ -0,0 +1 @@
+b2ef15d2af63854ee9dfdaa3978cf3eb
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.png
new file mode 100644
index 0000000..4539a44
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Density__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance-members.html b/classtimeloopfe_1_1v4_1_1problem_1_1Instance-members.html
new file mode 100644
index 0000000..796d6c8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Instance-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.problem.Instance, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.problem.Instance) | timeloopfe.v4.problem.Instance | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.problem.Instance |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance.html b/classtimeloopfe_1_1v4_1_1problem_1_1Instance.html
new file mode 100644
index 0000000..cd833af
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Instance.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
An problem instance object. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
An problem instance object.
+Attributes: name (str): The name of the instance. data_spaces (DataSpaceList): The data spaces of the instance. densities (DensityList): The densities of each data space.
+| timeloopfe.v4.problem.Instance.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.problem.Instance.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.map
new file mode 100644
index 0000000..45650bc
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.md5
new file mode 100644
index 0000000..f21b022
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.md5
@@ -0,0 +1 @@
+5b3256fd2f6df94c846b7349510f119b
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.png
new file mode 100644
index 0000000..81c2767
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.map
new file mode 100644
index 0000000..45650bc
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.md5
new file mode 100644
index 0000000..f21b022
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.md5
@@ -0,0 +1 @@
+5b3256fd2f6df94c846b7349510f119b
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.png
new file mode 100644
index 0000000..81c2767
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Instance__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem-members.html b/classtimeloopfe_1_1v4_1_1problem_1_1Problem-members.html
new file mode 100644
index 0000000..b217d85
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Problem-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.problem.Problem, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.problem.Problem) | timeloopfe.v4.problem.Problem | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.problem.Problem |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem.html b/classtimeloopfe_1_1v4_1_1problem_1_1Problem.html
new file mode 100644
index 0000000..e99ffb3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Problem.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
The top-level problem object in Timeloop. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
The top-level problem object in Timeloop.
+Attributes: version (str): The version of the problem. instance (Instance): The instance object for the problem. shape (Shape): The shape object for the problem.
+| timeloopfe.v4.problem.Problem.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.problem.Problem.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList-members.html b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList-members.html
new file mode 100644
index 0000000..115dca0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.problem.ProblemDataspaceList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.problem.ProblemDataspaceList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList.html b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList.html
new file mode 100644
index 0000000..9b6c62b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList.html
@@ -0,0 +1,324 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of data spaces in the problem. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of data spaces in the problem.
+| timeloopfe.v4.problem.ProblemDataspaceList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.map
new file mode 100644
index 0000000..87425bd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.md5
new file mode 100644
index 0000000..6aaf154
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.md5
@@ -0,0 +1 @@
+d3453d6ab625bf5513cf463eeec23336
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.png
new file mode 100644
index 0000000..60d2fc4
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.map
new file mode 100644
index 0000000..87425bd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.md5
new file mode 100644
index 0000000..6aaf154
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.md5
@@ -0,0 +1 @@
+d3453d6ab625bf5513cf463eeec23336
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.png
new file mode 100644
index 0000000..60d2fc4
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1ProblemDataspaceList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.map
new file mode 100644
index 0000000..9ddce6f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.md5
new file mode 100644
index 0000000..796ef7a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.md5
@@ -0,0 +1 @@
+1eac30480eb875463ea91d7c578e1b96
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.png
new file mode 100644
index 0000000..33e68be
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.map
new file mode 100644
index 0000000..9ddce6f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.md5
new file mode 100644
index 0000000..796ef7a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.md5
@@ -0,0 +1 @@
+1eac30480eb875463ea91d7c578e1b96
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.png
new file mode 100644
index 0000000..33e68be
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Problem__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape-members.html b/classtimeloopfe_1_1v4_1_1problem_1_1Shape-members.html
new file mode 100644
index 0000000..c414e64
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Shape-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.problem.Shape, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.problem.Shape) | timeloopfe.v4.problem.Shape | |
| dataspace2dims(self, Union[str, List[str]] name) | timeloopfe.v4.problem.Shape | |
| dataspace2unique_dims(self, str name) | timeloopfe.v4.problem.Shape | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.problem.Shape | |
| name2dataspace(self, Union[str, List[str]] name) | timeloopfe.v4.problem.Shape |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape.html b/classtimeloopfe_1_1v4_1_1problem_1_1Shape.html
new file mode 100644
index 0000000..1221df8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Shape.html
@@ -0,0 +1,493 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Problem shape object. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Union["DataSpace", List["DataSpace"]] | name2dataspace (self, Union[str, List[str]] name) |
| Convert the name of a data space to the corresponding DataSpace object(s). | |
| List[str] | dataspace2dims (self, Union[str, List[str]] name) |
| Convert the name(s) of data space(s) to the corresponding dimensions. | |
| List[str] | dataspace2unique_dims (self, str name) |
| Get the unique dimensions associated with a specific data space. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Problem shape object.
+Attributes: name (str): The name of the shape. dimensions (ListNode): The dimensions of the shape. data_spaces (ProblemDataspaceList): The data spaces of the shape. coefficients (ListNode): The coefficients of the shape.
+| timeloopfe.v4.problem.Shape.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| List[str] timeloopfe.v4.problem.Shape.dataspace2dims | +( | +self, | +|
| + | + | Union[str, List[str]] | name ) | +
Convert the name(s) of data space(s) to the corresponding dimensions.
+Args: name (Union[str, List[str]]): The name(s) of the data space(s) to convert.
+Returns: List[str]: The corresponding dimensions.
+Raises: ValueError: If the data space with the given name is not found.
+ +| List[str] timeloopfe.v4.problem.Shape.dataspace2unique_dims | +( | +self, | +|
| + | + | str | name ) | +
Get the unique dimensions associated with a specific data space.
+Args: name (str): The name of the data space.
+Returns: List[str]: The unique dimensions associated with the data space.
+ +| timeloopfe.v4.problem.Shape.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| Union["DataSpace", List["DataSpace"]] timeloopfe.v4.problem.Shape.name2dataspace | +( | +self, | +|
| + | + | Union[str, List[str]] + | name ) | +
Convert the name of a data space to the corresponding DataSpace object(s).
+Args: name (Union[str, List[str]]): The name(s) of the data space(s) to convert.
+Returns: Union[DataSpace, List[DataSpace]]: The corresponding DataSpace object(s).
+Raises: ValueError: If the data space with the given name is not found.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.map
new file mode 100644
index 0000000..9e1d039
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.md5
new file mode 100644
index 0000000..d829442
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.md5
@@ -0,0 +1 @@
+c2d334eac67928435b2c0d492bdb1e87
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.png
new file mode 100644
index 0000000..388ccad
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.map b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.map
new file mode 100644
index 0000000..9e1d039
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.md5
new file mode 100644
index 0000000..d829442
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.md5
@@ -0,0 +1 @@
+c2d334eac67928435b2c0d492bdb1e87
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.png b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.png
new file mode 100644
index 0000000..388ccad
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1problem_1_1Shape__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor-members.html b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor-members.html
new file mode 100644
index 0000000..26c2cfa
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor) | timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor | |
| _process_target(self, x, Specification spec) (defined in timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor) | timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor | protected |
| declare_attrs(self, *args, **kwargs) | timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor | |
| process(self, Specification spec) | timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor.html b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor.html
new file mode 100644
index 0000000..bfe2d8e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor.html
@@ -0,0 +1,248 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Takes constraints from constraints lists and attaches them to objects in the architecture. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| process (self, Specification spec) | |
| Process the specification. | |
| declare_attrs (self, *args, **kwargs) | |
| Initialize the attributes that the processor is responsible for. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Protected Member Functions | |
| + | _process_target (self, x, Specification spec) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Takes constraints from constraints lists and attaches them to objects in the architecture.
+| timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor.declare_attrs | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes that the processor is responsible for.
+!
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor.process | +( | +self, | +|
| + | + | Specification | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.map
new file mode 100644
index 0000000..7d37894
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.md5
new file mode 100644
index 0000000..a0fe0b3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.md5
@@ -0,0 +1 @@
+2e10b1c788e7e82b6ca6f297ce877146
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.png
new file mode 100644
index 0000000..a95acee
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.map
new file mode 100644
index 0000000..7d37894
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.md5
new file mode 100644
index 0000000..a0fe0b3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+2e10b1c788e7e82b6ca6f297ce877146
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.png
new file mode 100644
index 0000000..a95acee
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__attacher_1_1ConstraintAttacherProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor-members.html b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor-members.html
new file mode 100644
index 0000000..5adb31c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor-members.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor) | timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor | |
| declare_attrs(self) | timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor | |
| get_constrained_dims(self, Factors factors, Specification spec) (defined in timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor) | timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor | |
| get_unconstrained_dims(self, Specification spec) (defined in timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor) | timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor | |
| process(self, Specification spec) | timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor.html b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor.html
new file mode 100644
index 0000000..17e81a8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor.html
@@ -0,0 +1,248 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Defines constraint macros to be used for simplifying constraint specification. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| +Dict[str, int] | get_unconstrained_dims (self, Specification spec) |
| +Dict[str, int] | get_constrained_dims (self, Factors factors, Specification spec) |
| process (self, Specification spec) | |
| Process the specification. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Defines constraint macros to be used for simplifying constraint specification.
+Iteration constraint macros:
Dataspace constraint macros:
| timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor.declare_attrs | +( | +self | ) | ++ |
Initialize the attributes that the processor is responsible for.
+!
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor.process | +( | +self, | +|
| + | + | Specification | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.map
new file mode 100644
index 0000000..0c99804
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.md5
new file mode 100644
index 0000000..f099027
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.md5
@@ -0,0 +1 @@
+5eac50b7be5acf75cd095ba238ae0f3f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.png
new file mode 100644
index 0000000..f77a806
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.map
new file mode 100644
index 0000000..0c99804
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.md5
new file mode 100644
index 0000000..f099027
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+5eac50b7be5acf75cd095ba238ae0f3f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.png
new file mode 100644
index 0000000..f77a806
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1constraint__macro_1_1ConstraintMacroProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor-members.html b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor-members.html
new file mode 100644
index 0000000..24301de
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor, including all inherited members.
+| _get_kept_dataspaces(self, Node b) (defined in timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor) | timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor | protected |
| _parse_branch(self, Branch branch, Set[str] dataspaces, Specification spec) (defined in timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor) | timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor | protected |
| get_problem_ds_names(self, spec) (defined in timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor) | timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor | |
| process(self, Specification spec) | timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor.html b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor.html
new file mode 100644
index 0000000..e123981
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor.html
@@ -0,0 +1,195 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Resolves which data spaces are kept in which branches. + More...
+
+Public Member Functions | |
| +Set[str] | get_problem_ds_names (self, spec) |
| process (self, Specification spec) | |
| Process the specification. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| + | __init__ (self, Optional["Specification"] spec=None) |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Protected Member Functions | |
| +Set[str] | _get_kept_dataspaces (self, Node b) |
| +Set[str] | _parse_branch (self, Branch branch, Set[str] dataspaces, Specification spec) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Resolves which data spaces are kept in which branches.
+| timeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor.process | +( | +self, | +|
| + | + | Specification | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.map
new file mode 100644
index 0000000..0a49199
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.md5
new file mode 100644
index 0000000..2735777
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.md5
@@ -0,0 +1 @@
+652444e60829cfe29090844b967ef4d4
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.png
new file mode 100644
index 0000000..e7e7252
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.map
new file mode 100644
index 0000000..0a49199
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.md5
new file mode 100644
index 0000000..2735777
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+652444e60829cfe29090844b967ef4d4
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.png
new file mode 100644
index 0000000..e7e7252
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1dataspace2branch_1_1Dataspace2BranchProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor-members.html b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor-members.html
new file mode 100644
index 0000000..c1d4b3b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor) | timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor | |
| process(self, Specification spec) | timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor.html b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor.html
new file mode 100644
index 0000000..8a66822
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor.html
@@ -0,0 +1,210 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Enable the dummy table for Accelergy to placeholder energy/area. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| process (self, Specification spec) | |
| Process the specification. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Enable the dummy table for Accelergy to placeholder energy/area.
+| timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor.process | +( | +self, | +|
| + | + | Specification | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.map
new file mode 100644
index 0000000..0d5924c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.md5
new file mode 100644
index 0000000..187d188
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.md5
@@ -0,0 +1 @@
+3ce31ea05c3cb9941727d9f78885696f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.png
new file mode 100644
index 0000000..654c5b1
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.map
new file mode 100644
index 0000000..0d5924c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.md5
new file mode 100644
index 0000000..187d188
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+3ce31ea05c3cb9941727d9f78885696f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.png
new file mode 100644
index 0000000..654c5b1
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1enable__dummy__table_1_1EnableDummyTableProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor-members.html b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor-members.html
new file mode 100644
index 0000000..2d2689d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor) | timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor | |
| process(self, Specification spec) | timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor.html b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor.html
new file mode 100644
index 0000000..6d23e0f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor.html
@@ -0,0 +1,210 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Optimizes permutation by pruning superfluous permutations. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| process (self, Specification spec) | |
| Process the specification. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Optimizes permutation by pruning superfluous permutations.
+| timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor.process | +( | +self, | +|
| + | + | Specification | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.map
new file mode 100644
index 0000000..88094ef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.md5
new file mode 100644
index 0000000..0ef7d37
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.md5
@@ -0,0 +1 @@
+2f13138781f40537863f80e37fe24df9
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.png
new file mode 100644
index 0000000..827c27b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.map
new file mode 100644
index 0000000..88094ef
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.md5
new file mode 100644
index 0000000..0ef7d37
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+2f13138781f40537863f80e37fe24df9
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.png
new file mode 100644
index 0000000..827c27b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1permutation__optimizer_1_1PermutationOptimizerProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor-members.html b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor-members.html
new file mode 100644
index 0000000..23b111a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.processors.required_actions.RequiredActionsProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.processors.required_actions.RequiredActionsProcessor) | timeloopfe.v4.processors.required_actions.RequiredActionsProcessor | |
| check_compute(self, Component elem) (defined in timeloopfe.v4.processors.required_actions.RequiredActionsProcessor) | timeloopfe.v4.processors.required_actions.RequiredActionsProcessor | |
| check_storage(self, Storage elem) (defined in timeloopfe.v4.processors.required_actions.RequiredActionsProcessor) | timeloopfe.v4.processors.required_actions.RequiredActionsProcessor | |
| process(self, Specification spec) | timeloopfe.v4.processors.required_actions.RequiredActionsProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor.html b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor.html
new file mode 100644
index 0000000..ad423ab
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor.html
@@ -0,0 +1,272 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Ensures that all components have actions defined for Accelergy Storage: + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| + | check_storage (self, Storage elem) |
| + | check_compute (self, Component elem) |
| process (self, Specification spec) | |
| Process the specification. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Ensures that all components have actions defined for Accelergy Storage:
+DEPRECATED. NOW ALL OF THE FOLLOWING ARE NOT REQUIRED. Deprecated because: Skipped/gated actions can just be no action decompression_count/compression_count is not supported in many of the plug-ins that Sparseloop uses
+| timeloopfe.v4.processors.required_actions.RequiredActionsProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.required_actions.RequiredActionsProcessor.process | +( | +self, | +|
| + | + | Specification | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.map
new file mode 100644
index 0000000..78a1575
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.md5
new file mode 100644
index 0000000..02eedfd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.md5
@@ -0,0 +1 @@
+d250e41c214a6a01b808a57e271eb638
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.png
new file mode 100644
index 0000000..ff84e4d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.map
new file mode 100644
index 0000000..78a1575
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.md5
new file mode 100644
index 0000000..02eedfd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+d250e41c214a6a01b808a57e271eb638
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.png
new file mode 100644
index 0000000..ff84e4d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1required__actions_1_1RequiredActionsProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor-members.html b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor-members.html
new file mode 100644
index 0000000..8ab5fed
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor) | timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor | |
| process(self, Specification spec) | timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor.html b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor.html
new file mode 100644
index 0000000..5f6fac6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor.html
@@ -0,0 +1,210 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Takes sparse optimizations from sparse optimizations lists and attaches them to the architecture. + More...
+
+Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| process (self, Specification spec) | |
| Process the specification. | |
| Public Member Functions inherited from timeloopfe.common.processor.Processor | |
| declare_attrs (self) | |
| Initialize the attributes that the processor is responsible for. | |
| + | get_index (self, type processor_type, "Specification" spec) |
| Get the index of the processor in the list of processors. | |
| must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False) | |
| Ensure that this processor runs after another processor. | |
| + | add_attr (self, Node target, *args, **kwargs) |
+Additional Inherited Members | |
| Public Attributes inherited from timeloopfe.common.processor.Processor | |
| + | logger |
| + | spec |
Takes sparse optimizations from sparse optimizations lists and attaches them to the architecture.
+| timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.processor.Processor.
+ +| timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor.process | +( | +self, | +|
| + | + | Specification | spec ) | +
Process the specification.
+ +Reimplemented from timeloopfe.common.processor.Processor.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.map
new file mode 100644
index 0000000..e0cfd33
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.md5
new file mode 100644
index 0000000..11450b6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.md5
@@ -0,0 +1 @@
+6aa800aa61a75c096a2828321448b161
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.png
new file mode 100644
index 0000000..351c437
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.map b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.map
new file mode 100644
index 0000000..e0cfd33
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.map
@@ -0,0 +1,7 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.md5
new file mode 100644
index 0000000..11450b6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.md5
@@ -0,0 +1 @@
+6aa800aa61a75c096a2828321448b161
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.png b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.png
new file mode 100644
index 0000000..351c437
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1processors_1_1sparse__opt__attacher_1_1SparseOptAttacherProcessor__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization-members.html
new file mode 100644
index 0000000..22fb173
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.ActionOptimization, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.ActionOptimization) | timeloopfe.v4.sparse_optimizations.ActionOptimization | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.ActionOptimization |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization.html
new file mode 100644
index 0000000..3548608
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
An action optimization. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
An action optimization.
+Attributes: type (str): The type of action optimization. One of "gating", "skipping", "spatial_skipping". options (ActionOptimizationOptionList): A list of action optimization options.
+| timeloopfe.v4.sparse_optimizations.ActionOptimization.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.ActionOptimization.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList-members.html
new file mode 100644
index 0000000..f9729df
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.ActionOptimizationList, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.ActionOptimizationList) | timeloopfe.v4.sparse_optimizations.ActionOptimizationList | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.ActionOptimizationList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList.html
new file mode 100644
index 0000000..ea875f5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList.html
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of action optimizations. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of action optimizations.
+| timeloopfe.v4.sparse_optimizations.ActionOptimizationList.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ +| timeloopfe.v4.sparse_optimizations.ActionOptimizationList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.map
new file mode 100644
index 0000000..052e7b0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.md5
new file mode 100644
index 0000000..af35e46
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.md5
@@ -0,0 +1 @@
+6df3d81b72c52286b744f259cb349994
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.png
new file mode 100644
index 0000000..bb55e9b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.map
new file mode 100644
index 0000000..052e7b0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.md5
new file mode 100644
index 0000000..af35e46
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.md5
@@ -0,0 +1 @@
+6df3d81b72c52286b744f259cb349994
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.png
new file mode 100644
index 0000000..bb55e9b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption-members.html
new file mode 100644
index 0000000..f5f37ce
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.ActionOptimizationOption, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.ActionOptimizationOption) | timeloopfe.v4.sparse_optimizations.ActionOptimizationOption | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.ActionOptimizationOption |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption.html
new file mode 100644
index 0000000..837ce12
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
An action optimization option. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
An action optimization option.
+Attributes: target (str): The target of the optimization. condition_on (list): Which tensor(s) to condition on.
+| timeloopfe.v4.sparse_optimizations.ActionOptimizationOption.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.ActionOptimizationOption.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList-members.html
new file mode 100644
index 0000000..d132144
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList) | timeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList.html
new file mode 100644
index 0000000..9acae29
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList.html
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of action optimization options. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of action optimization options.
+| timeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ +| timeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.map
new file mode 100644
index 0000000..22ebdf6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.md5
new file mode 100644
index 0000000..8f733e5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.md5
@@ -0,0 +1 @@
+0357310cd580d119d46e9a275a80c5ba
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.png
new file mode 100644
index 0000000..dff5c59
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.map
new file mode 100644
index 0000000..22ebdf6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.md5
new file mode 100644
index 0000000..8f733e5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.md5
@@ -0,0 +1 @@
+0357310cd580d119d46e9a275a80c5ba
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.png
new file mode 100644
index 0000000..dff5c59
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOptionList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.map
new file mode 100644
index 0000000..95fc130
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.md5
new file mode 100644
index 0000000..12e6b62
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.md5
@@ -0,0 +1 @@
+f7efb3a94891dab3094013ccd8edd340
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.png
new file mode 100644
index 0000000..e465595
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.map
new file mode 100644
index 0000000..95fc130
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.md5
new file mode 100644
index 0000000..12e6b62
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.md5
@@ -0,0 +1 @@
+f7efb3a94891dab3094013ccd8edd340
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.png
new file mode 100644
index 0000000..e465595
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimizationOption__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.map
new file mode 100644
index 0000000..cc290aa
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.md5
new file mode 100644
index 0000000..c6e6d1d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.md5
@@ -0,0 +1 @@
+72509325e89d185d632a332364d31bfc
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.png
new file mode 100644
index 0000000..1dd914f
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.map
new file mode 100644
index 0000000..cc290aa
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.md5
new file mode 100644
index 0000000..c6e6d1d
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.md5
@@ -0,0 +1 @@
+72509325e89d185d632a332364d31bfc
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.png
new file mode 100644
index 0000000..1dd914f
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ActionOptimization__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization-members.html
new file mode 100644
index 0000000..61210e4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.ComputeOptimization, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.ComputeOptimization) | timeloopfe.v4.sparse_optimizations.ComputeOptimization | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.ComputeOptimization |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization.html
new file mode 100644
index 0000000..83c1cbd
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A compute optimization. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A compute optimization.
+Attributes: type (str): The type of compute optimization. One of "gating", "skipping". options (ActionOptimizationOptionList): A list of action optimization options.
+| timeloopfe.v4.sparse_optimizations.ComputeOptimization.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.ComputeOptimization.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.map
new file mode 100644
index 0000000..e12cb19
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.md5
new file mode 100644
index 0000000..f5c9ce6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.md5
@@ -0,0 +1 @@
+96fdb1716367c5c2f7e131b2213fb41e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.png
new file mode 100644
index 0000000..85b8026
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.map
new file mode 100644
index 0000000..e12cb19
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.md5
new file mode 100644
index 0000000..f5c9ce6
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.md5
@@ -0,0 +1 @@
+96fdb1716367c5c2f7e131b2213fb41e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.png
new file mode 100644
index 0000000..85b8026
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1ComputeOptimization__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace-members.html
new file mode 100644
index 0000000..79adb95
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.RepresentationDataSpace, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.RepresentationDataSpace) | timeloopfe.v4.sparse_optimizations.RepresentationDataSpace | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.RepresentationDataSpace |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace.html
new file mode 100644
index 0000000..4bb3eb4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace.html
@@ -0,0 +1,405 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Contains the representation format for a data space. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Contains the representation format for a data space.
+| timeloopfe.v4.sparse_optimizations.RepresentationDataSpace.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.RepresentationDataSpace.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.map
new file mode 100644
index 0000000..492ff14
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.md5
new file mode 100644
index 0000000..0bf5817
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.md5
@@ -0,0 +1 @@
+dcf4c6f1d0310c7f84bf8a0c9c80fd40
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.png
new file mode 100644
index 0000000..d902f95
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.map
new file mode 100644
index 0000000..492ff14
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.md5
new file mode 100644
index 0000000..0bf5817
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.md5
@@ -0,0 +1 @@
+dcf4c6f1d0310c7f84bf8a0c9c80fd40
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.png
new file mode 100644
index 0000000..d902f95
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationDataSpace__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat-members.html
new file mode 100644
index 0000000..7e341bf
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.RepresentationFormat, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.RepresentationFormat) | timeloopfe.v4.sparse_optimizations.RepresentationFormat | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.RepresentationFormat |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat.html
new file mode 100644
index 0000000..82eb7f5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A representation format sparse optimization. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A representation format sparse optimization.
+Attributes: data_spaces (RepresentationProblemDataspaceList): A list of data spaces.
+| timeloopfe.v4.sparse_optimizations.RepresentationFormat.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.RepresentationFormat.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.map
new file mode 100644
index 0000000..54c1fb0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.md5
new file mode 100644
index 0000000..1f9ca02
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.md5
@@ -0,0 +1 @@
+64c16e131cab95c5413d953a1c5690a3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.png
new file mode 100644
index 0000000..0b45e5e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.map
new file mode 100644
index 0000000..54c1fb0
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.md5
new file mode 100644
index 0000000..1f9ca02
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.md5
@@ -0,0 +1 @@
+64c16e131cab95c5413d953a1c5690a3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.png
new file mode 100644
index 0000000..0b45e5e
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationFormat__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList-members.html
new file mode 100644
index 0000000..902fec4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList) | timeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList.html
new file mode 100644
index 0000000..5298e62
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList.html
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of representation problem dataspaces. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of representation problem dataspaces.
+| timeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ +| timeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.map
new file mode 100644
index 0000000..45216e3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.md5
new file mode 100644
index 0000000..a189577
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.md5
@@ -0,0 +1 @@
+84886a073436e9c73969bea42dc02a3f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.png
new file mode 100644
index 0000000..bea66ca
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.map
new file mode 100644
index 0000000..45216e3
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.md5
new file mode 100644
index 0000000..a189577
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.md5
@@ -0,0 +1 @@
+84886a073436e9c73969bea42dc02a3f
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.png
new file mode 100644
index 0000000..bea66ca
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationProblemDataspaceList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank-members.html
new file mode 100644
index 0000000..9ac039c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.RepresentationRank, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.RepresentationRank) | timeloopfe.v4.sparse_optimizations.RepresentationRank | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.RepresentationRank |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank.html
new file mode 100644
index 0000000..7b4a3ee
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A representation rank. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A representation rank.
+Attributes: name (str): The name of the rank. format (str): The format of the rank. One of "CP", "B", "RLE", "UOP". metadata_word_bits (int): The number of metadata word bits. payload_word_bits (int): The number of payload word bits. flattened_rankIDs (list): A list of flattened rank IDs.
+| timeloopfe.v4.sparse_optimizations.RepresentationRank.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.RepresentationRank.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList-members.html
new file mode 100644
index 0000000..dc35e6c
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.RepresentationRankList, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.RepresentationRankList) | timeloopfe.v4.sparse_optimizations.RepresentationRankList | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.RepresentationRankList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList.html
new file mode 100644
index 0000000..a4a42e7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList.html
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of ranks to be used in the representation format. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of ranks to be used in the representation format.
+| timeloopfe.v4.sparse_optimizations.RepresentationRankList.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.ListNode.
+ +| timeloopfe.v4.sparse_optimizations.RepresentationRankList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.map
new file mode 100644
index 0000000..1ccc774
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.md5
new file mode 100644
index 0000000..402db50
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.md5
@@ -0,0 +1 @@
+e4aadf69809b14c04e30711ce5b64b98
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.png
new file mode 100644
index 0000000..c961bfe
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.map
new file mode 100644
index 0000000..1ccc774
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.md5
new file mode 100644
index 0000000..402db50
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.md5
@@ -0,0 +1 @@
+e4aadf69809b14c04e30711ce5b64b98
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.png
new file mode 100644
index 0000000..c961bfe
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRankList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.map
new file mode 100644
index 0000000..b96c27f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.md5
new file mode 100644
index 0000000..7b0fee1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.md5
@@ -0,0 +1 @@
+e3ccecb885ab11064cf6cc758bca8759
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.png
new file mode 100644
index 0000000..c7b5e92
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.map
new file mode 100644
index 0000000..b96c27f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.md5
new file mode 100644
index 0000000..7b0fee1
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.md5
@@ -0,0 +1 @@
+e3ccecb885ab11064cf6cc758bca8759
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.png
new file mode 100644
index 0000000..c7b5e92
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1RepresentationRank__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup-members.html
new file mode 100644
index 0000000..d842694
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup) | timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup | |
| isempty(self) | timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup.html
new file mode 100644
index 0000000..2858d57
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup.html
@@ -0,0 +1,428 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A group of sparse optimizations. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| bool | isempty (self) |
| Check if the sparse optimization group is empty. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A group of sparse optimizations.
+Attributes: target (str): The target of the sparse optimization group. action_optimization (ActionOptimization): The action optimization associated with the group. representation_format (RepresentationFormat): The representation format associated with the group. compute_optimization (ComputeOptimization): The compute optimization associated with the group.
+| timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ +| bool timeloopfe.v4.sparse_optimizations.SparseOptimizationGroup.isempty | +( | +self | ) | ++ |
Check if the sparse optimization group is empty.
+Returns: bool: True if the group is empty, False otherwise.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.map
new file mode 100644
index 0000000..56fc06a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.md5
new file mode 100644
index 0000000..20e7ed4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.md5
@@ -0,0 +1 @@
+5f8529cc62af5f38defa647818749f8e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.png
new file mode 100644
index 0000000..1058f62
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.map
new file mode 100644
index 0000000..56fc06a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.md5
new file mode 100644
index 0000000..20e7ed4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.md5
@@ -0,0 +1 @@
+5f8529cc62af5f38defa647818749f8e
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.png
new file mode 100644
index 0000000..1058f62
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationGroup__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations-members.html
new file mode 100644
index 0000000..2697f77
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations-members.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.SparseOptimizations, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.sparse_optimizations.SparseOptimizations) | timeloopfe.v4.sparse_optimizations.SparseOptimizations | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.SparseOptimizations |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations.html
new file mode 100644
index 0000000..81b1bfc
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations.html
@@ -0,0 +1,406 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
Top-level class for sparse optimizations. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
Top-level class for sparse optimizations.
+Attributes: version (str): The version of the sparse optimizations. targets (SparseOptimizationsList): A list of sparse optimizations.
+| timeloopfe.v4.sparse_optimizations.SparseOptimizations.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.sparse_optimizations.SparseOptimizations.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList-members.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList-members.html
new file mode 100644
index 0000000..b2e172b
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList-members.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.sparse_optimizations.SparseOptimizationsList, including all inherited members.
+| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.sparse_optimizations.SparseOptimizationsList |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList.html b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList.html
new file mode 100644
index 0000000..bd7d4e8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList.html
@@ -0,0 +1,326 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A list of sparse optimizations. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| Public Member Functions inherited from timeloopfe.common.nodes.ListNode | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False) | |
| Check for unrecognized keys in this node and all subnodes. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| Any | __getitem__ (self, Union[str, int] key) |
| Get the value at the given key or index. | |
| __setitem__ (self, Union[str, int] key, Any value) | |
| Set the value at the given key or index. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A list of sparse optimizations.
+
+
| timeloopfe.v4.sparse_optimizations.SparseOptimizationsList.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.map
new file mode 100644
index 0000000..a71630f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.md5
new file mode 100644
index 0000000..2265988
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.md5
@@ -0,0 +1 @@
+29301b5989ef0807d6e2d8b2d621e560
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.png
new file mode 100644
index 0000000..7c38f7d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.map
new file mode 100644
index 0000000..a71630f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.md5
new file mode 100644
index 0000000..2265988
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.md5
@@ -0,0 +1 @@
+29301b5989ef0807d6e2d8b2d621e560
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.png
new file mode 100644
index 0000000..7c38f7d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizationsList__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.map
new file mode 100644
index 0000000..31906a4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.md5
new file mode 100644
index 0000000..c32879e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.md5
@@ -0,0 +1 @@
+8491c37dd703528a6e7f538484699786
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.png
new file mode 100644
index 0000000..6da7286
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.map b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.map
new file mode 100644
index 0000000..31906a4
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.md5
new file mode 100644
index 0000000..c32879e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.md5
@@ -0,0 +1 @@
+8491c37dd703528a6e7f538484699786
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.png b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.png
new file mode 100644
index 0000000..6da7286
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1sparse__optimizations_1_1SparseOptimizations__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification-members.html b/classtimeloopfe_1_1v4_1_1specification_1_1Specification-members.html
new file mode 100644
index 0000000..6d6f78a
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1specification_1_1Specification-members.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.specification.Specification, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.specification.Specification) | timeloopfe.v4.specification.Specification | |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.specification.Specification | |
| parse_expressions(self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | timeloopfe.v4.specification.Specification | |
| variables (defined in timeloopfe.v4.specification.Specification) | timeloopfe.v4.specification.Specification |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification.html b/classtimeloopfe_1_1v4_1_1specification_1_1Specification.html
new file mode 100644
index 0000000..dc0deb8
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1specification_1_1Specification.html
@@ -0,0 +1,491 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A top-level class for the Timeloop specification. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None) | |
| Parse expressions in the specification. | |
| Public Member Functions inherited from timeloopfe.common.base_specification.BaseSpecification | |
| + | needs_processing (self, Optional[List["Processor"]] with_processors=None, Optional[List["Processor"]] to_run=None) |
| process (self, Union["Processor", List["Processor"]] with_processors=None, bool check_types=False, bool check_types_ignore_empty=True, bool reprocess=True) | |
| Process the specification with the given processors. | |
| "Specification" | from_yaml_files (cls, *args, **kwargs) |
| Create a Specification object from YAML files. | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Public Attributes | |
| + | variables |
| Public Attributes inherited from timeloopfe.common.base_specification.BaseSpecification | |
| + | processors |
| + | spec |
| + | preserve_references |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Protected Member Functions inherited from timeloopfe.common.base_specification.BaseSpecification | |
| + | _claim_nodes (self, *args, **kwargs) |
| + | _processors_declare_attrs (self, *args, **kwargs) |
| + | _early_init_processors (self, List["Processor"] _required_processors, **kwargs) |
| + | _process (self) |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
| Protected Attributes inherited from timeloopfe.common.base_specification.BaseSpecification | |
| + | _required_processors |
| + | _processor_attributes |
| + | _parsed_expressions |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
A top-level class for the Timeloop specification.
+Attributes: architecture: The top-level architecture description. components: List of compound components. constraints: Additional constraints on the architecture and mapping. mapping: Additional constraints on the architecture and mapping. problem: The problem specification. variables: Variables to be used in parsing. mapper: Directives to control the mapping process. sparse_optimizations: Additional sparse optimizations available to the architecture. mapspace: The top-level mapspace description. globals: Global inclusion of extra parsing functions and environment variables.
+Note: Inherits from BaseSpecification.
+| timeloopfe.v4.specification.Specification.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.base_specification.BaseSpecification.
+ +| timeloopfe.v4.specification.Specification.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.base_specification.BaseSpecification.
+ +| timeloopfe.v4.specification.Specification.parse_expressions | +( | +self, | +|
| + | + | Optional[Dict[str, Any]] | symbol_table = None, | +
| + | + | Optional[set] | parsed_ids = None ) | +
Parse expressions in the specification.
+Args: symbol_table (Optional[Dict[str, Any]], optional): Symbol table to be used for parsing. Defaults to None. parsed_ids (Optional[set], optional): Set of IDs of specifications that have already been parsed. Defaults to None.
+ +Reimplemented from timeloopfe.common.base_specification.BaseSpecification.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.map b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.map
new file mode 100644
index 0000000..e4607ad
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.md5
new file mode 100644
index 0000000..9be6ebc
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.md5
@@ -0,0 +1 @@
+4ee074375589709b00123ed048e89f5c
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.png b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.png
new file mode 100644
index 0000000..e53dc0b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.map b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.map
new file mode 100644
index 0000000..e4607ad
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.map
@@ -0,0 +1,14 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.md5
new file mode 100644
index 0000000..9be6ebc
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.md5
@@ -0,0 +1 @@
+4ee074375589709b00123ed048e89f5c
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.png b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.png
new file mode 100644
index 0000000..e53dc0b
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1specification_1_1Specification__inherit__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables-members.html b/classtimeloopfe_1_1v4_1_1variables_1_1Variables-members.html
new file mode 100644
index 0000000..57a2de7
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1variables_1_1Variables-members.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This is the complete list of members for timeloopfe.v4.variables.Variables, including all inherited members.
+| __init__(self, *args, **kwargs) (defined in timeloopfe.v4.variables.Variables) | timeloopfe.v4.variables.Variables | |
| _default_parse (defined in timeloopfe.v4.variables.Variables) | timeloopfe.v4.variables.Variables | protected |
| declare_attrs(cls, *args, **kwargs) | timeloopfe.v4.variables.Variables |
1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables.html b/classtimeloopfe_1_1v4_1_1variables_1_1Variables.html
new file mode 100644
index 0000000..de68dd5
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1variables_1_1Variables.html
@@ -0,0 +1,413 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
A top-level class for variables. + More...
+
+Public Member Functions | |
| declare_attrs (cls, *args, **kwargs) | |
| Initialize the attributes of this node. | |
| __init__ (self, *args, **kwargs) | |
| Public Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| + | require_one_of (cls, *args) |
| Require that at least one of the given keys is present. | |
| + | require_all_or_none_of (cls, *args) |
| Require that all or none of the given keys are present. | |
| "DictNode" | combine (self, "DictNode" other) |
| Combines this dictionary with another dictionary. | |
| "DictNode" | from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs) |
| Loads a dictionary from one more more yaml files. | |
| Any | __getitem__ (self, Any __key) |
| Get the value at the given key or index. | |
| None | __setitem__ (self, Any __key, Any __value) |
| Set the value at the given key or index. | |
| +Any | get (self, Any __key, Any __default=None) |
| Gets a key from the dictionary. | |
| +Any | setdefault (self, Any __key, Any __default=None) |
| Sets the default value for a key. | |
| +Any | pop (self, Any __key, Any __default=None) |
| Pops a key from the dictionary. | |
| None | check_unrecognized (self, *args, **kwargs) |
| Check for unrecognized keys in this node and all subnodes. | |
| + | __getattr__ (self, name) |
| Index into the attributes or the contents of this node. | |
| + | __setattr__ (self, name, value) |
| Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| + | get_specifiers_from_processors (cls, "BaseSpecification" spec) |
| Get the specifiers that have been set from processors. | |
| + | reset_specifiers_from_processors (cls, Optional[Type] processor=None) |
| Reset the specifiers that have been set from processors. | |
| + | reset_processor_elems (cls, Optional[Type] processor=None) |
| recognize_all (cls, bool recognize_all=True) | |
| Set whether all attributes under this node should be recognized. | |
| +str | get_tag (self) |
| Get the tag of this node. | |
| +Iterable[Tuple[Union[str, int], Any]] | items (self) |
| Get iterable of (key, value) or (index, value) pairs. | |
| T | combine_index (self, Union[str, int] key, T value) |
| Combine the value at the given key with the given value. | |
| +str | get_name (self, Union[Set, None] seen=None) |
| Get the name of this node. | |
| Any | recursive_apply (self, callable func, bool self_first=False, set applied_to=None) |
| Apply a function to this node and all subnodes. | |
| + | clean_empties (self) |
| Remove empty nodes from this node and all subnodes. | |
| bool | isempty (self) |
| Return True if this node is empty. | |
| +bool | isempty_recursive (self) |
| Return True if this node or all subnodes are empty. | |
| add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None) | |
| Initialize a type specifier for this class. | |
| List[T] | get_nodes_of_type (self, Type[T] node_type) |
| Return a list of all subnodes of a given type. | |
| Callable | get_setter_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to set a value in this node. | |
| Callable | get_combiner_lambda (self, Union[str, int] keytag) |
| Get a function that can be used to combine a value to this node. | |
| List[Tuple[Any, Callable]] | get_setters_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_combiners_for_keytag (self, str keytag, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag. | |
| List[Tuple[Any, Callable]] | get_setters_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type. | |
| List[Tuple[Any, Callable]] | get_combiners_for_type (self, Type t, bool recursive=True) |
| Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type. | |
| __str__ (self) | |
| Return the name of this node. | |
| + | __format__ (self, format_spec) |
| Formats the name of this node. | |
| +bool | is_defined_non_default_non_empty (self, str key) |
| Returns True if the given key is defined in this node and is not the default value and is not empty. | |
| parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None) | |
| Parse expressions in this node and all subnodes. | |
| + | unique_class_name (cls) |
| Return a unique name for this class. | |
+Protected Attributes | |
| + | _default_parse |
| Protected Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | _require_one_of |
| + | _require_all_or_none_of |
| Protected Attributes inherited from timeloopfe.common.nodes.Node | |
| + | _default_parse |
+Additional Inherited Members | |
| Static Public Member Functions inherited from timeloopfe.common.nodes.Node | |
| +"BaseSpecification" | get_global_spec () |
| Get the global specification object. | |
| + | set_global_spec ("BaseSpecification" spec) |
| Set the global specification object. | |
| Any | try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None) |
| Try to combine two values. | |
| Public Attributes inherited from timeloopfe.common.nodes.DictNode | |
| + | spec |
| Public Attributes inherited from timeloopfe.common.nodes.Node | |
| + | logger |
| + | parent_node |
| + | spec |
| Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +None | _check_alias (self, key) |
| Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| Dict[str, TypeSpecifier] | _get_type_specifiers (cls, "BaseSpecification" spec) |
| Get the type specifiers for this node. | |
| + | _get_all_recognized (self) |
| +Dict[Union[str, int], TypeSpecifier] | _get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None) |
| + | _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None) |
| + | _parse_elems (self) |
| + | _parse_extra_elems (self, List[Tuple[str, Any]] key2elem) |
| + | _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False) |
| + | _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.DictNode | |
| +Dict[Any, Any] | _to_dict (Any x) |
| Static Protected Member Functions inherited from timeloopfe.common.nodes.Node | |
| +str | _get_tag (x) |
A top-level class for variables.
+These will be available to parsing at all other points in the specification.
+| timeloopfe.v4.variables.Variables.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Reimplemented from timeloopfe.common.nodes.DictNode.
+ +| timeloopfe.v4.variables.Variables.declare_attrs | +( | +cls, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Initialize the attributes of this node.
+ +Reimplemented from timeloopfe.common.nodes.Node.
+ + 1.10.0
+
+
+
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.map b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.map
new file mode 100644
index 0000000..a5a387f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.md5 b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.md5
new file mode 100644
index 0000000..4a5e42e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.md5
@@ -0,0 +1 @@
+ba01f7e88779f4b596531d6bc4e787c3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.png b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.png
new file mode 100644
index 0000000..099b99d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__coll__graph.png differ
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.map b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.map
new file mode 100644
index 0000000..a5a387f
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.map
@@ -0,0 +1,11 @@
+
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.md5 b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.md5
new file mode 100644
index 0000000..4a5e42e
--- /dev/null
+++ b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.md5
@@ -0,0 +1 @@
+ba01f7e88779f4b596531d6bc4e787c3
\ No newline at end of file
diff --git a/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.png b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.png
new file mode 100644
index 0000000..099b99d
Binary files /dev/null and b/classtimeloopfe_1_1v4_1_1variables_1_1Variables__inherit__graph.png differ
diff --git a/clipboard.js b/clipboard.js
new file mode 100644
index 0000000..42c1fb0
--- /dev/null
+++ b/clipboard.js
@@ -0,0 +1,61 @@
+/**
+
+The code below is based on the Doxygen Awesome project, see
+https://github.com/jothepro/doxygen-awesome-css
+
+MIT License
+
+Copyright (c) 2021 - 2022 jothepro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+*/
+
+let clipboard_title = "Copy to clipboard"
+let clipboard_icon = ``
+let clipboard_successIcon = ``
+let clipboard_successDuration = 1000
+
+$(function() {
+ if(navigator.clipboard) {
+ const fragments = document.getElementsByClassName("fragment")
+ for(const fragment of fragments) {
+ const clipboard_div = document.createElement("div")
+ clipboard_div.classList.add("clipboard")
+ clipboard_div.innerHTML = clipboard_icon
+ clipboard_div.title = clipboard_title
+ $(clipboard_div).click(function() {
+ const content = this.parentNode.cloneNode(true)
+ // filter out line number and folded fragments from file listings
+ content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
+ let text = content.textContent
+ // remove trailing newlines and trailing spaces from empty lines
+ text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
+ navigator.clipboard.writeText(text);
+ this.classList.add("success")
+ this.innerHTML = clipboard_successIcon
+ window.setTimeout(() => { // switch back to normal icon after timeout
+ this.classList.remove("success")
+ this.innerHTML = clipboard_icon
+ }, clipboard_successDuration);
+ })
+ fragment.insertBefore(clipboard_div, fragment.firstChild)
+ }
+ }
+})
diff --git a/closed.png b/closed.png
new file mode 100644
index 0000000..98cc2c9
Binary files /dev/null and b/closed.png differ
diff --git a/cookie.js b/cookie.js
new file mode 100644
index 0000000..53ad21d
--- /dev/null
+++ b/cookie.js
@@ -0,0 +1,58 @@
+/*!
+ Cookie helper functions
+ Copyright (c) 2023 Dimitri van Heesch
+ Released under MIT license.
+*/
+let Cookie = {
+ cookie_namespace: 'doxygen_',
+
+ readSetting(cookie,defVal) {
+ if (window.chrome) {
+ const val = localStorage.getItem(this.cookie_namespace+cookie) ||
+ sessionStorage.getItem(this.cookie_namespace+cookie);
+ if (val) return val;
+ } else {
+ let myCookie = this.cookie_namespace+cookie+"=";
+ if (document.cookie) {
+ const index = document.cookie.indexOf(myCookie);
+ if (index != -1) {
+ const valStart = index + myCookie.length;
+ let valEnd = document.cookie.indexOf(";", valStart);
+ if (valEnd == -1) {
+ valEnd = document.cookie.length;
+ }
+ return document.cookie.substring(valStart, valEnd);
+ }
+ }
+ }
+ return defVal;
+ },
+
+ writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
+ if (window.chrome) {
+ if (days==0) {
+ sessionStorage.setItem(this.cookie_namespace+cookie,val);
+ } else {
+ localStorage.setItem(this.cookie_namespace+cookie,val);
+ }
+ } else {
+ let date = new Date();
+ date.setTime(date.getTime()+(days*24*60*60*1000));
+ const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
+ document.cookie = this.cookie_namespace + cookie + "=" +
+ val + "; SameSite=Lax;" + expiration + "path=/";
+ }
+ },
+
+ eraseSetting(cookie) {
+ if (window.chrome) {
+ if (localStorage.getItem(this.cookie_namespace+cookie)) {
+ localStorage.removeItem(this.cookie_namespace+cookie);
+ } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
+ sessionStorage.removeItem(this.cookie_namespace+cookie);
+ }
+ } else {
+ this.writeSetting(cookie,'',-1);
+ }
+ },
+}
diff --git a/dir_5eda70f7a4354e6cc879b210b8e16120.html b/dir_5eda70f7a4354e6cc879b210b8e16120.html
new file mode 100644
index 0000000..3277d06
--- /dev/null
+++ b/dir_5eda70f7a4354e6cc879b210b8e16120.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/dir_5eda70f7a4354e6cc879b210b8e16120_dep.map b/dir_5eda70f7a4354e6cc879b210b8e16120_dep.map
new file mode 100644
index 0000000..e3313e2
--- /dev/null
+++ b/dir_5eda70f7a4354e6cc879b210b8e16120_dep.map
@@ -0,0 +1,4 @@
+
diff --git a/dir_5eda70f7a4354e6cc879b210b8e16120_dep.md5 b/dir_5eda70f7a4354e6cc879b210b8e16120_dep.md5
new file mode 100644
index 0000000..f7831cf
--- /dev/null
+++ b/dir_5eda70f7a4354e6cc879b210b8e16120_dep.md5
@@ -0,0 +1 @@
+602e4670ff4bcac08aff1ebe22f2721e
\ No newline at end of file
diff --git a/dir_5eda70f7a4354e6cc879b210b8e16120_dep.png b/dir_5eda70f7a4354e6cc879b210b8e16120_dep.png
new file mode 100644
index 0000000..01d3f85
Binary files /dev/null and b/dir_5eda70f7a4354e6cc879b210b8e16120_dep.png differ
diff --git a/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57.html b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57.html
new file mode 100644
index 0000000..e768482
--- /dev/null
+++ b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.map b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.map
new file mode 100644
index 0000000..9c6cfc2
--- /dev/null
+++ b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.map
@@ -0,0 +1,5 @@
+
diff --git a/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.md5 b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.md5
new file mode 100644
index 0000000..568f55f
--- /dev/null
+++ b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.md5
@@ -0,0 +1 @@
+324309bb72da932e8d9d871bf8adc34d
\ No newline at end of file
diff --git a/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.png b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.png
new file mode 100644
index 0000000..5eed15a
Binary files /dev/null and b/dir_7edb5bc8ff5c3893cc3d7ea7e26cee57_dep.png differ
diff --git a/dir_d6db356613cf00bcfdb067f02ec7e914.html b/dir_d6db356613cf00bcfdb067f02ec7e914.html
new file mode 100644
index 0000000..beae83d
--- /dev/null
+++ b/dir_d6db356613cf00bcfdb067f02ec7e914.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/dir_d6db356613cf00bcfdb067f02ec7e914_dep.map b/dir_d6db356613cf00bcfdb067f02ec7e914_dep.map
new file mode 100644
index 0000000..abad49d
--- /dev/null
+++ b/dir_d6db356613cf00bcfdb067f02ec7e914_dep.map
@@ -0,0 +1,4 @@
+
diff --git a/dir_d6db356613cf00bcfdb067f02ec7e914_dep.md5 b/dir_d6db356613cf00bcfdb067f02ec7e914_dep.md5
new file mode 100644
index 0000000..0abcfff
--- /dev/null
+++ b/dir_d6db356613cf00bcfdb067f02ec7e914_dep.md5
@@ -0,0 +1 @@
+8d92f86a2ec0b5dadfd953bdb0187500
\ No newline at end of file
diff --git a/dir_d6db356613cf00bcfdb067f02ec7e914_dep.png b/dir_d6db356613cf00bcfdb067f02ec7e914_dep.png
new file mode 100644
index 0000000..5eac8be
Binary files /dev/null and b/dir_d6db356613cf00bcfdb067f02ec7e914_dep.png differ
diff --git a/dir_eb7959291d4899a8523ee09666e584ca.html b/dir_eb7959291d4899a8523ee09666e584ca.html
new file mode 100644
index 0000000..8858f72
--- /dev/null
+++ b/dir_eb7959291d4899a8523ee09666e584ca.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/dir_f911da6abbf989b8631bb22d56744199.html b/dir_f911da6abbf989b8631bb22d56744199.html
new file mode 100644
index 0000000..f06ba04
--- /dev/null
+++ b/dir_f911da6abbf989b8631bb22d56744199.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/dir_f911da6abbf989b8631bb22d56744199_dep.map b/dir_f911da6abbf989b8631bb22d56744199_dep.map
new file mode 100644
index 0000000..3a7e296
--- /dev/null
+++ b/dir_f911da6abbf989b8631bb22d56744199_dep.map
@@ -0,0 +1,5 @@
+
diff --git a/dir_f911da6abbf989b8631bb22d56744199_dep.md5 b/dir_f911da6abbf989b8631bb22d56744199_dep.md5
new file mode 100644
index 0000000..a02b214
--- /dev/null
+++ b/dir_f911da6abbf989b8631bb22d56744199_dep.md5
@@ -0,0 +1 @@
+705f60eea5f2b1b2fdedd5b627358e22
\ No newline at end of file
diff --git a/dir_f911da6abbf989b8631bb22d56744199_dep.png b/dir_f911da6abbf989b8631bb22d56744199_dep.png
new file mode 100644
index 0000000..c130c3c
Binary files /dev/null and b/dir_f911da6abbf989b8631bb22d56744199_dep.png differ
diff --git a/doc.svg b/doc.svg
new file mode 100644
index 0000000..0b928a5
--- /dev/null
+++ b/doc.svg
@@ -0,0 +1,12 @@
+
+
+
diff --git a/docd.svg b/docd.svg
new file mode 100644
index 0000000..ac18b27
--- /dev/null
+++ b/docd.svg
@@ -0,0 +1,12 @@
+
+
+
diff --git a/doxygen.css b/doxygen.css
new file mode 100644
index 0000000..7b7d851
--- /dev/null
+++ b/doxygen.css
@@ -0,0 +1,2225 @@
+/* The standard CSS for doxygen 1.10.0*/
+
+html {
+/* page base colors */
+--page-background-color: white;
+--page-foreground-color: black;
+--page-link-color: #3D578C;
+--page-visited-link-color: #4665A2;
+
+/* index */
+--index-odd-item-bg-color: #F8F9FC;
+--index-even-item-bg-color: white;
+--index-header-color: black;
+--index-separator-color: #A0A0A0;
+
+/* header */
+--header-background-color: #F9FAFC;
+--header-separator-color: #C4CFE5;
+--header-gradient-image: url('nav_h.png');
+--group-header-separator-color: #879ECB;
+--group-header-color: #354C7B;
+--inherit-header-color: gray;
+
+--footer-foreground-color: #2A3D61;
+--footer-logo-width: 104px;
+--citation-label-color: #334975;
+--glow-color: cyan;
+
+--title-background-color: white;
+--title-separator-color: #5373B4;
+--directory-separator-color: #9CAFD4;
+--separator-color: #4A6AAA;
+
+--blockquote-background-color: #F7F8FB;
+--blockquote-border-color: #9CAFD4;
+
+--scrollbar-thumb-color: #9CAFD4;
+--scrollbar-background-color: #F9FAFC;
+
+--icon-background-color: #728DC1;
+--icon-foreground-color: white;
+--icon-doc-image: url('doc.svg');
+--icon-folder-open-image: url('folderopen.svg');
+--icon-folder-closed-image: url('folderclosed.svg');
+
+/* brief member declaration list */
+--memdecl-background-color: #F9FAFC;
+--memdecl-separator-color: #DEE4F0;
+--memdecl-foreground-color: #555;
+--memdecl-template-color: #4665A2;
+
+/* detailed member list */
+--memdef-border-color: #A8B8D9;
+--memdef-title-background-color: #E2E8F2;
+--memdef-title-gradient-image: url('nav_f.png');
+--memdef-proto-background-color: #DFE5F1;
+--memdef-proto-text-color: #253555;
+--memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+--memdef-doc-background-color: white;
+--memdef-param-name-color: #602020;
+--memdef-template-color: #4665A2;
+
+/* tables */
+--table-cell-border-color: #2D4068;
+--table-header-background-color: #374F7F;
+--table-header-foreground-color: #FFFFFF;
+
+/* labels */
+--label-background-color: #728DC1;
+--label-left-top-border-color: #5373B4;
+--label-right-bottom-border-color: #C4CFE5;
+--label-foreground-color: white;
+
+/** navigation bar/tree/menu */
+--nav-background-color: #F9FAFC;
+--nav-foreground-color: #364D7C;
+--nav-gradient-image: url('tab_b.png');
+--nav-gradient-hover-image: url('tab_h.png');
+--nav-gradient-active-image: url('tab_a.png');
+--nav-gradient-active-image-parent: url("../tab_a.png");
+--nav-separator-image: url('tab_s.png');
+--nav-breadcrumb-image: url('bc_s.png');
+--nav-breadcrumb-border-color: #C2CDE4;
+--nav-splitbar-image: url('splitbar.png');
+--nav-font-size-level1: 13px;
+--nav-font-size-level2: 10px;
+--nav-font-size-level3: 9px;
+--nav-text-normal-color: #283A5D;
+--nav-text-hover-color: white;
+--nav-text-active-color: white;
+--nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+--nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+--nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+--nav-menu-button-color: #364D7C;
+--nav-menu-background-color: white;
+--nav-menu-foreground-color: #555555;
+--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
+--nav-arrow-color: #9CAFD4;
+--nav-arrow-selected-color: #9CAFD4;
+
+/* table of contents */
+--toc-background-color: #F4F6FA;
+--toc-border-color: #D8DFEE;
+--toc-header-color: #4665A2;
+--toc-down-arrow-image: url("data:image/svg+xml;utf8,");
+
+/** search field */
+--search-background-color: white;
+--search-foreground-color: #909090;
+--search-magnification-image: url('mag.svg');
+--search-magnification-select-image: url('mag_sel.svg');
+--search-active-color: black;
+--search-filter-background-color: #F9FAFC;
+--search-filter-foreground-color: black;
+--search-filter-border-color: #90A5CE;
+--search-filter-highlight-text-color: white;
+--search-filter-highlight-bg-color: #3D578C;
+--search-results-foreground-color: #425E97;
+--search-results-background-color: #EEF1F7;
+--search-results-border-color: black;
+--search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+
+/** code fragments */
+--code-keyword-color: #008000;
+--code-type-keyword-color: #604020;
+--code-flow-keyword-color: #E08000;
+--code-comment-color: #800000;
+--code-preprocessor-color: #806020;
+--code-string-literal-color: #002080;
+--code-char-literal-color: #008080;
+--code-xml-cdata-color: black;
+--code-vhdl-digit-color: #FF00FF;
+--code-vhdl-char-color: #000000;
+--code-vhdl-keyword-color: #700070;
+--code-vhdl-logic-color: #FF0000;
+--code-link-color: #4665A2;
+--code-external-link-color: #4665A2;
+--fragment-foreground-color: black;
+--fragment-background-color: #FBFCFD;
+--fragment-border-color: #C4CFE5;
+--fragment-lineno-border-color: #00FF00;
+--fragment-lineno-background-color: #E8E8E8;
+--fragment-lineno-foreground-color: black;
+--fragment-lineno-link-fg-color: #4665A2;
+--fragment-lineno-link-bg-color: #D8D8D8;
+--fragment-lineno-link-hover-fg-color: #4665A2;
+--fragment-lineno-link-hover-bg-color: #C8C8C8;
+--fragment-copy-ok-color: #2EC82E;
+--tooltip-foreground-color: black;
+--tooltip-background-color: white;
+--tooltip-border-color: gray;
+--tooltip-doc-color: grey;
+--tooltip-declaration-color: #006318;
+--tooltip-link-color: #4665A2;
+--tooltip-shadow: 1px 1px 7px gray;
+--fold-line-color: #808080;
+--fold-minus-image: url('minus.svg');
+--fold-plus-image: url('plus.svg');
+--fold-minus-image-relpath: url('../../minus.svg');
+--fold-plus-image-relpath: url('../../plus.svg');
+
+/** font-family */
+--font-family-normal: Roboto,sans-serif;
+--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
+--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+--font-family-title: Tahoma,Arial,sans-serif;
+--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
+--font-family-search: Arial,Verdana,sans-serif;
+--font-family-icon: Arial,Helvetica;
+--font-family-tooltip: Roboto,sans-serif;
+
+/** special sections */
+--warning-color-bg: #f8d1cc;
+--warning-color-hl: #b61825;
+--warning-color-text: #75070f;
+--note-color-bg: #faf3d8;
+--note-color-hl: #f3a600;
+--note-color-text: #5f4204;
+--todo-color-bg: #e4f3ff;
+--todo-color-hl: #1879C4;
+--todo-color-text: #274a5c;
+--test-color-bg: #e8e8ff;
+--test-color-hl: #3939C4;
+--test-color-text: #1a1a5c;
+--deprecated-color-bg: #ecf0f3;
+--deprecated-color-hl: #5b6269;
+--deprecated-color-text: #43454a;
+--bug-color-bg: #e4dafd;
+--bug-color-hl: #5b2bdd;
+--bug-color-text: #2a0d72;
+--invariant-color-bg: #d8f1e3;
+--invariant-color-hl: #44b86f;
+--invariant-color-text: #265532;
+}
+
+@media (prefers-color-scheme: dark) {
+ html:not(.dark-mode) {
+ color-scheme: dark;
+
+/* page base colors */
+--page-background-color: black;
+--page-foreground-color: #C9D1D9;
+--page-link-color: #90A5CE;
+--page-visited-link-color: #A3B4D7;
+
+/* index */
+--index-odd-item-bg-color: #0B101A;
+--index-even-item-bg-color: black;
+--index-header-color: #C4CFE5;
+--index-separator-color: #334975;
+
+/* header */
+--header-background-color: #070B11;
+--header-separator-color: #141C2E;
+--header-gradient-image: url('nav_hd.png');
+--group-header-separator-color: #283A5D;
+--group-header-color: #90A5CE;
+--inherit-header-color: #A0A0A0;
+
+--footer-foreground-color: #5B7AB7;
+--footer-logo-width: 60px;
+--citation-label-color: #90A5CE;
+--glow-color: cyan;
+
+--title-background-color: #090D16;
+--title-separator-color: #354C79;
+--directory-separator-color: #283A5D;
+--separator-color: #283A5D;
+
+--blockquote-background-color: #101826;
+--blockquote-border-color: #283A5D;
+
+--scrollbar-thumb-color: #283A5D;
+--scrollbar-background-color: #070B11;
+
+--icon-background-color: #334975;
+--icon-foreground-color: #C4CFE5;
+--icon-doc-image: url('docd.svg');
+--icon-folder-open-image: url('folderopend.svg');
+--icon-folder-closed-image: url('folderclosedd.svg');
+
+/* brief member declaration list */
+--memdecl-background-color: #0B101A;
+--memdecl-separator-color: #2C3F65;
+--memdecl-foreground-color: #BBB;
+--memdecl-template-color: #7C95C6;
+
+/* detailed member list */
+--memdef-border-color: #233250;
+--memdef-title-background-color: #1B2840;
+--memdef-title-gradient-image: url('nav_fd.png');
+--memdef-proto-background-color: #19243A;
+--memdef-proto-text-color: #9DB0D4;
+--memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
+--memdef-doc-background-color: black;
+--memdef-param-name-color: #D28757;
+--memdef-template-color: #7C95C6;
+
+/* tables */
+--table-cell-border-color: #283A5D;
+--table-header-background-color: #283A5D;
+--table-header-foreground-color: #C4CFE5;
+
+/* labels */
+--label-background-color: #354C7B;
+--label-left-top-border-color: #4665A2;
+--label-right-bottom-border-color: #283A5D;
+--label-foreground-color: #CCCCCC;
+
+/** navigation bar/tree/menu */
+--nav-background-color: #101826;
+--nav-foreground-color: #364D7C;
+--nav-gradient-image: url('tab_bd.png');
+--nav-gradient-hover-image: url('tab_hd.png');
+--nav-gradient-active-image: url('tab_ad.png');
+--nav-gradient-active-image-parent: url("../tab_ad.png");
+--nav-separator-image: url('tab_sd.png');
+--nav-breadcrumb-image: url('bc_sd.png');
+--nav-breadcrumb-border-color: #2A3D61;
+--nav-splitbar-image: url('splitbard.png');
+--nav-font-size-level1: 13px;
+--nav-font-size-level2: 10px;
+--nav-font-size-level3: 9px;
+--nav-text-normal-color: #B6C4DF;
+--nav-text-hover-color: #DCE2EF;
+--nav-text-active-color: #DCE2EF;
+--nav-text-normal-shadow: 0px 1px 1px black;
+--nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+--nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+--nav-menu-button-color: #B6C4DF;
+--nav-menu-background-color: #05070C;
+--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
+--nav-arrow-color: #334975;
+--nav-arrow-selected-color: #90A5CE;
+
+/* table of contents */
+--toc-background-color: #151E30;
+--toc-border-color: #202E4A;
+--toc-header-color: #A3B4D7;
+--toc-down-arrow-image: url("data:image/svg+xml;utf8,");
+
+/** search field */
+--search-background-color: black;
+--search-foreground-color: #C5C5C5;
+--search-magnification-image: url('mag_d.svg');
+--search-magnification-select-image: url('mag_seld.svg');
+--search-active-color: #C5C5C5;
+--search-filter-background-color: #101826;
+--search-filter-foreground-color: #90A5CE;
+--search-filter-border-color: #7C95C6;
+--search-filter-highlight-text-color: #BCC9E2;
+--search-filter-highlight-bg-color: #283A5D;
+--search-results-background-color: #101826;
+--search-results-foreground-color: #90A5CE;
+--search-results-border-color: #7C95C6;
+--search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+
+/** code fragments */
+--code-keyword-color: #CC99CD;
+--code-type-keyword-color: #AB99CD;
+--code-flow-keyword-color: #E08000;
+--code-comment-color: #717790;
+--code-preprocessor-color: #65CABE;
+--code-string-literal-color: #7EC699;
+--code-char-literal-color: #00E0F0;
+--code-xml-cdata-color: #C9D1D9;
+--code-vhdl-digit-color: #FF00FF;
+--code-vhdl-char-color: #C0C0C0;
+--code-vhdl-keyword-color: #CF53C9;
+--code-vhdl-logic-color: #FF0000;
+--code-link-color: #79C0FF;
+--code-external-link-color: #79C0FF;
+--fragment-foreground-color: #C9D1D9;
+--fragment-background-color: #090D16;
+--fragment-border-color: #30363D;
+--fragment-lineno-border-color: #30363D;
+--fragment-lineno-background-color: black;
+--fragment-lineno-foreground-color: #6E7681;
+--fragment-lineno-link-fg-color: #6E7681;
+--fragment-lineno-link-bg-color: #303030;
+--fragment-lineno-link-hover-fg-color: #8E96A1;
+--fragment-lineno-link-hover-bg-color: #505050;
+--fragment-copy-ok-color: #0EA80E;
+--tooltip-foreground-color: #C9D1D9;
+--tooltip-background-color: #202020;
+--tooltip-border-color: #C9D1D9;
+--tooltip-doc-color: #D9E1E9;
+--tooltip-declaration-color: #20C348;
+--tooltip-link-color: #79C0FF;
+--tooltip-shadow: none;
+--fold-line-color: #808080;
+--fold-minus-image: url('minusd.svg');
+--fold-plus-image: url('plusd.svg');
+--fold-minus-image-relpath: url('../../minusd.svg');
+--fold-plus-image-relpath: url('../../plusd.svg');
+
+/** font-family */
+--font-family-normal: Roboto,sans-serif;
+--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
+--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+--font-family-title: Tahoma,Arial,sans-serif;
+--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
+--font-family-search: Arial,Verdana,sans-serif;
+--font-family-icon: Arial,Helvetica;
+--font-family-tooltip: Roboto,sans-serif;
+
+/** special sections */
+--warning-color-bg: #2e1917;
+--warning-color-hl: #ad2617;
+--warning-color-text: #f5b1aa;
+--note-color-bg: #3b2e04;
+--note-color-hl: #f1b602;
+--note-color-text: #ceb670;
+--todo-color-bg: #163750;
+--todo-color-hl: #1982D2;
+--todo-color-text: #dcf0fa;
+--test-color-bg: #121258;
+--test-color-hl: #4242cf;
+--test-color-text: #c0c0da;
+--deprecated-color-bg: #2e323b;
+--deprecated-color-hl: #738396;
+--deprecated-color-text: #abb0bd;
+--bug-color-bg: #2a2536;
+--bug-color-hl: #7661b3;
+--bug-color-text: #ae9ed6;
+--invariant-color-bg: #303a35;
+--invariant-color-hl: #76ce96;
+--invariant-color-text: #cceed5;
+}}
+body {
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
+}
+
+body, table, div, p, dl {
+ font-weight: 400;
+ font-size: 14px;
+ font-family: var(--font-family-normal);
+ line-height: 22px;
+}
+
+/* @group Heading Levels */
+
+.title {
+ font-family: var(--font-family-normal);
+ line-height: 28px;
+ font-size: 150%;
+ font-weight: bold;
+ margin: 10px 2px;
+}
+
+h1.groupheader {
+ font-size: 150%;
+}
+
+h2.groupheader {
+ border-bottom: 1px solid var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 150%;
+ font-weight: normal;
+ margin-top: 1.75em;
+ padding-top: 8px;
+ padding-bottom: 4px;
+ width: 100%;
+}
+
+h3.groupheader {
+ font-size: 100%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ -webkit-transition: text-shadow 0.5s linear;
+ -moz-transition: text-shadow 0.5s linear;
+ -ms-transition: text-shadow 0.5s linear;
+ -o-transition: text-shadow 0.5s linear;
+ transition: text-shadow 0.5s linear;
+ margin-right: 15px;
+}
+
+h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
+ text-shadow: 0 0 15px var(--glow-color);
+}
+
+dt {
+ font-weight: bold;
+}
+
+p.startli, p.startdd {
+ margin-top: 2px;
+}
+
+th p.starttd, th p.intertd, th p.endtd {
+ font-size: 100%;
+ font-weight: 700;
+}
+
+p.starttd {
+ margin-top: 0px;
+}
+
+p.endli {
+ margin-bottom: 0px;
+}
+
+p.enddd {
+ margin-bottom: 4px;
+}
+
+p.endtd {
+ margin-bottom: 2px;
+}
+
+p.interli {
+}
+
+p.interdd {
+}
+
+p.intertd {
+}
+
+/* @end */
+
+caption {
+ font-weight: bold;
+}
+
+span.legend {
+ font-size: 70%;
+ text-align: center;
+}
+
+h3.version {
+ font-size: 90%;
+ text-align: center;
+}
+
+div.navtab {
+ padding-right: 15px;
+ text-align: right;
+ line-height: 110%;
+}
+
+div.navtab table {
+ border-spacing: 0;
+}
+
+td.navtab {
+ padding-right: 6px;
+ padding-left: 6px;
+}
+
+td.navtabHL {
+ background-image: var(--nav-gradient-active-image);
+ background-repeat:repeat-x;
+ padding-right: 6px;
+ padding-left: 6px;
+}
+
+td.navtabHL a, td.navtabHL a:visited {
+ color: var(--nav-text-hover-color);
+ text-shadow: var(--nav-text-hover-shadow);
+}
+
+a.navtab {
+ font-weight: bold;
+}
+
+div.qindex{
+ text-align: center;
+ width: 100%;
+ line-height: 140%;
+ font-size: 130%;
+ color: var(--index-separator-color);
+}
+
+#main-menu a:focus {
+ outline: auto;
+ z-index: 10;
+ position: relative;
+}
+
+dt.alphachar{
+ font-size: 180%;
+ font-weight: bold;
+}
+
+.alphachar a{
+ color: var(--index-header-color);
+}
+
+.alphachar a:hover, .alphachar a:visited{
+ text-decoration: none;
+}
+
+.classindex dl {
+ padding: 25px;
+ column-count:1
+}
+
+.classindex dd {
+ display:inline-block;
+ margin-left: 50px;
+ width: 90%;
+ line-height: 1.15em;
+}
+
+.classindex dl.even {
+ background-color: var(--index-even-item-bg-color);
+}
+
+.classindex dl.odd {
+ background-color: var(--index-odd-item-bg-color);
+}
+
+@media(min-width: 1120px) {
+ .classindex dl {
+ column-count:2
+ }
+}
+
+@media(min-width: 1320px) {
+ .classindex dl {
+ column-count:3
+ }
+}
+
+
+/* @group Link Styling */
+
+a {
+ color: var(--page-link-color);
+ font-weight: normal;
+ text-decoration: none;
+}
+
+.contents a:visited {
+ color: var(--page-visited-link-color);
+}
+
+a:hover {
+ text-decoration: none;
+ background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
+}
+
+a:hover > span.arrow {
+ text-decoration: none;
+ background : var(--nav-background-color);
+}
+
+a.el {
+ font-weight: bold;
+}
+
+a.elRef {
+}
+
+a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--code-link-color);
+}
+
+a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
+ color: var(--code-external-link-color);
+}
+
+a.code.hl_class { /* style for links to class names in code snippets */ }
+a.code.hl_struct { /* style for links to struct names in code snippets */ }
+a.code.hl_union { /* style for links to union names in code snippets */ }
+a.code.hl_interface { /* style for links to interface names in code snippets */ }
+a.code.hl_protocol { /* style for links to protocol names in code snippets */ }
+a.code.hl_category { /* style for links to category names in code snippets */ }
+a.code.hl_exception { /* style for links to exception names in code snippets */ }
+a.code.hl_service { /* style for links to service names in code snippets */ }
+a.code.hl_singleton { /* style for links to singleton names in code snippets */ }
+a.code.hl_concept { /* style for links to concept names in code snippets */ }
+a.code.hl_namespace { /* style for links to namespace names in code snippets */ }
+a.code.hl_package { /* style for links to package names in code snippets */ }
+a.code.hl_define { /* style for links to macro names in code snippets */ }
+a.code.hl_function { /* style for links to function names in code snippets */ }
+a.code.hl_variable { /* style for links to variable names in code snippets */ }
+a.code.hl_typedef { /* style for links to typedef names in code snippets */ }
+a.code.hl_enumvalue { /* style for links to enum value names in code snippets */ }
+a.code.hl_enumeration { /* style for links to enumeration names in code snippets */ }
+a.code.hl_signal { /* style for links to Qt signal names in code snippets */ }
+a.code.hl_slot { /* style for links to Qt slot names in code snippets */ }
+a.code.hl_friend { /* style for links to friend names in code snippets */ }
+a.code.hl_dcop { /* style for links to KDE3 DCOP names in code snippets */ }
+a.code.hl_property { /* style for links to property names in code snippets */ }
+a.code.hl_event { /* style for links to event names in code snippets */ }
+a.code.hl_sequence { /* style for links to sequence names in code snippets */ }
+a.code.hl_dictionary { /* style for links to dictionary names in code snippets */ }
+
+/* @end */
+
+dl.el {
+ margin-left: -1cm;
+}
+
+ul {
+ overflow: visible;
+}
+
+ul.multicol {
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
+}
+
+#side-nav ul {
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+}
+
+#main-nav ul {
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+}
+
+.fragment {
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
+}
+
+pre.fragment {
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+.clipboard {
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: auto;
+ fill: var(--fragment-foreground-color);
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
+}
+
+.clipboard.success {
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
+}
+
+.fragment:hover .clipboard, .clipboard.success {
+ opacity: .28;
+}
+
+.clipboard:hover, .clipboard.success {
+ opacity: 1 !important;
+}
+
+.clipboard:active:not([class~=success]) svg {
+ transform: scale(.91);
+}
+
+.clipboard.success svg {
+ fill: var(--fragment-copy-ok-color);
+}
+
+.clipboard.success {
+ border-color: var(--fragment-copy-ok-color);
+}
+
+div.line {
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ min-height: 13px;
+ line-height: 1.2;
+ text-wrap: unrestricted;
+ white-space: -moz-pre-wrap; /* Moz */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ white-space: pre-wrap; /* CSS3 */
+ word-wrap: break-word; /* IE 5.5+ */
+ text-indent: -53px;
+ padding-left: 53px;
+ padding-bottom: 0px;
+ margin: 0px;
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+div.line:after {
+ content:"\000A";
+ white-space: pre;
+}
+
+div.line.glow {
+ background-color: var(--glow-color);
+ box-shadow: 0 0 10px var(--glow-color);
+}
+
+span.fold {
+ margin-left: 5px;
+ margin-right: 1px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+ display: inline-block;
+ width: 12px;
+ height: 12px;
+ background-repeat:no-repeat;
+ background-position:center;
+}
+
+span.lineno {
+ padding-right: 4px;
+ margin-right: 9px;
+ text-align: right;
+ border-right: 2px solid var(--fragment-lineno-border-color);
+ color: var(--fragment-lineno-foreground-color);
+ background-color: var(--fragment-lineno-background-color);
+ white-space: pre;
+}
+span.lineno a, span.lineno a:visited {
+ color: var(--fragment-lineno-link-fg-color);
+ background-color: var(--fragment-lineno-link-bg-color);
+}
+
+span.lineno a:hover {
+ color: var(--fragment-lineno-link-hover-fg-color);
+ background-color: var(--fragment-lineno-link-hover-bg-color);
+}
+
+.lineno {
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+div.classindex ul {
+ list-style: none;
+ padding-left: 0;
+}
+
+div.classindex span.ai {
+ display: inline-block;
+}
+
+div.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ font-weight: bold;
+}
+
+div.groupText {
+ margin-left: 16px;
+ font-style: italic;
+}
+
+body {
+ color: var(--page-foreground-color);
+ margin: 0;
+}
+
+div.contents {
+ margin-top: 10px;
+ margin-left: 12px;
+ margin-right: 8px;
+}
+
+p.formulaDsp {
+ text-align: center;
+}
+
+img.dark-mode-visible {
+ display: none;
+}
+img.light-mode-visible {
+ display: none;
+}
+
+img.formulaInl, img.inline {
+ vertical-align: middle;
+}
+
+div.center {
+ text-align: center;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+}
+
+div.center img {
+ border: 0px;
+}
+
+address.footer {
+ text-align: right;
+ padding-right: 12px;
+}
+
+img.footer {
+ border: 0px;
+ vertical-align: middle;
+ width: var(--footer-logo-width);
+}
+
+.compoundTemplParams {
+ color: var(--memdecl-template-color);
+ font-size: 80%;
+ line-height: 120%;
+}
+
+/* @group Code Colorization */
+
+span.keyword {
+ color: var(--code-keyword-color);
+}
+
+span.keywordtype {
+ color: var(--code-type-keyword-color);
+}
+
+span.keywordflow {
+ color: var(--code-flow-keyword-color);
+}
+
+span.comment {
+ color: var(--code-comment-color);
+}
+
+span.preprocessor {
+ color: var(--code-preprocessor-color);
+}
+
+span.stringliteral {
+ color: var(--code-string-literal-color);
+}
+
+span.charliteral {
+ color: var(--code-char-literal-color);
+}
+
+span.xmlcdata {
+ color: var(--code-xml-cdata-color);
+}
+
+span.vhdldigit {
+ color: var(--code-vhdl-digit-color);
+}
+
+span.vhdlchar {
+ color: var(--code-vhdl-char-color);
+}
+
+span.vhdlkeyword {
+ color: var(--code-vhdl-keyword-color);
+}
+
+span.vhdllogic {
+ color: var(--code-vhdl-logic-color);
+}
+
+blockquote {
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
+}
+
+/* @end */
+
+td.tiny {
+ font-size: 75%;
+}
+
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid var(--table-cell-border-color);
+}
+
+th.dirtab {
+ background-color: var(--table-header-background-color);
+ color: var(--table-header-foreground-color);
+ font-weight: bold;
+}
+
+hr {
+ height: 0px;
+ border: none;
+ border-top: 1px solid var(--separator-color);
+}
+
+hr.footer {
+ height: 1px;
+}
+
+/* @group Member Descriptions */
+
+table.memberdecls {
+ border-spacing: 0px;
+ padding: 0px;
+}
+
+.memberdecls td, .fieldtable tr {
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+.memberdecls td.glow, .fieldtable tr.glow {
+ background-color: var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
+}
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+ background-color: var(--memdecl-background-color);
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+ padding: 0px 8px 4px 8px;
+ color: var(--memdecl-foreground-color);
+}
+
+.memSeparator {
+ border-bottom: 1px solid var(--memdecl-separator-color);
+ line-height: 1px;
+ margin: 0px;
+ padding: 0px;
+}
+
+.memItemLeft, .memTemplItemLeft {
+ white-space: nowrap;
+}
+
+.memItemRight, .memTemplItemRight {
+ width: 100%;
+}
+
+.memTemplParams {
+ color: var(--memdecl-template-color);
+ white-space: nowrap;
+ font-size: 80%;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation */
+
+.memtitle {
+ padding: 8px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ margin-bottom: -1px;
+ background-image: var(--memdef-title-gradient-image);
+ background-repeat: repeat-x;
+ background-color: var(--memdef-title-background-color);
+ line-height: 1.25;
+ font-weight: 300;
+ float:left;
+}
+
+.permalink
+{
+ font-size: 65%;
+ display: inline-block;
+ vertical-align: middle;
+}
+
+.memtemplate {
+ font-size: 80%;
+ color: var(--memdef-template-color);
+ font-weight: normal;
+ margin-left: 9px;
+}
+
+.mempage {
+ width: 100%;
+}
+
+.memitem {
+ padding: 0;
+ margin-bottom: 10px;
+ margin-right: 5px;
+ -webkit-transition: box-shadow 0.5s linear;
+ -moz-transition: box-shadow 0.5s linear;
+ -ms-transition: box-shadow 0.5s linear;
+ -o-transition: box-shadow 0.5s linear;
+ transition: box-shadow 0.5s linear;
+ display: table !important;
+ width: 100%;
+}
+
+.memitem.glow {
+ box-shadow: 0 0 15px var(--glow-color);
+}
+
+.memname {
+ font-weight: 400;
+ margin-left: 6px;
+}
+
+.memname td {
+ vertical-align: bottom;
+}
+
+.memproto, dl.reflist dt {
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ text-shadow: var(--memdef-proto-text-shadow);
+ background-color: var(--memdef-proto-background-color);
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-top-right-radius: 4px;
+}
+
+.overload {
+ font-family: var(--font-family-monospace);
+ font-size: 65%;
+}
+
+.memdoc, dl.reflist dd {
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ background-image:url('nav_g.png');
+ background-repeat:repeat-x;
+ background-color: var(--memdef-doc-background-color);
+ /* opera specific markup */
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ /* firefox specific markup */
+ -moz-border-radius-bottomleft: 4px;
+ -moz-border-radius-bottomright: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ /* webkit specific markup */
+ -webkit-border-bottom-left-radius: 4px;
+ -webkit-border-bottom-right-radius: 4px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+}
+
+dl.reflist dt {
+ padding: 5px;
+}
+
+dl.reflist dd {
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
+}
+
+.paramkey {
+ text-align: right;
+}
+
+.paramtype {
+ white-space: nowrap;
+ padding: 0px;
+ padding-bottom: 1px;
+}
+
+.paramname {
+ white-space: nowrap;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
+}
+
+.paramname em {
+ color: var(--memdef-param-name-color);
+ font-style: normal;
+ margin-right: 1px;
+}
+
+.paramname .paramdefval {
+ font-family: var(--font-family-monospace);
+}
+
+.params, .retval, .exception, .tparams {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
+ font-weight: bold;
+ vertical-align: top;
+}
+
+.params .paramtype, .tparams .paramtype {
+ font-style: italic;
+ vertical-align: top;
+}
+
+.params .paramdir, .tparams .paramdir {
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
+}
+
+table.mlabels {
+ border-spacing: 0px;
+}
+
+td.mlabels-left {
+ width: 100%;
+ padding: 0px;
+}
+
+td.mlabels-right {
+ vertical-align: bottom;
+ padding: 0px;
+ white-space: nowrap;
+}
+
+span.mlabels {
+ margin-left: 8px;
+}
+
+span.mlabel {
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
+ text-shadow: none;
+ color: var(--label-foreground-color);
+ margin-right: 4px;
+ padding: 2px 3px;
+ border-radius: 3px;
+ font-size: 7pt;
+ white-space: nowrap;
+ vertical-align: middle;
+}
+
+
+
+/* @end */
+
+/* these are for tree view inside a (index) page */
+
+div.directory {
+ margin: 10px 0px;
+ border-top: 1px solid var(--directory-separator-color);
+ border-bottom: 1px solid var(--directory-separator-color);
+ width: 100%;
+}
+
+.directory table {
+ border-collapse:collapse;
+}
+
+.directory td {
+ margin: 0px;
+ padding: 0px;
+ vertical-align: top;
+}
+
+.directory td.entry {
+ white-space: nowrap;
+ padding-right: 6px;
+ padding-top: 3px;
+}
+
+.directory td.entry a {
+ outline:none;
+}
+
+.directory td.entry a img {
+ border: none;
+}
+
+.directory td.desc {
+ width: 100%;
+ padding-left: 6px;
+ padding-right: 6px;
+ padding-top: 3px;
+ border-left: 1px solid rgba(0,0,0,0.05);
+}
+
+.directory tr.odd {
+ padding-left: 6px;
+ background-color: var(--index-odd-item-bg-color);
+}
+
+.directory tr.even {
+ padding-left: 6px;
+ background-color: var(--index-even-item-bg-color);
+}
+
+.directory img {
+ vertical-align: -30%;
+}
+
+.directory .levels {
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
+}
+
+.directory .levels span {
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
+ color: var(--page-link-color);
+}
+
+.arrow {
+ color: var(--nav-arrow-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 22px;
+}
+
+.icon {
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
+}
+
+.icona {
+ width: 24px;
+ height: 22px;
+ display: inline-block;
+}
+
+.iconfopen {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:var(--icon-folder-open-image);
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.iconfclosed {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:var(--icon-folder-closed-image);
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:var(--icon-doc-image);
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+/* @end */
+
+div.dynheader {
+ margin-top: 8px;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+address {
+ font-style: normal;
+ color: var(--footer-foreground-color);
+}
+
+table.doxtable caption {
+ caption-side: top;
+}
+
+table.doxtable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.doxtable td, table.doxtable th {
+ border: 1px solid var(--table-cell-border-color);
+ padding: 3px 7px 2px;
+}
+
+table.doxtable th {
+ background-color: var(--table-header-background-color);
+ color: var(--table-header-foreground-color);
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+table.fieldtable {
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+}
+
+.fieldtable td, .fieldtable th {
+ padding: 3px 7px 2px;
+}
+
+.fieldtable td.fieldtype, .fieldtable td.fieldname {
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
+}
+
+.fieldtable td.fieldname {
+ padding-top: 3px;
+}
+
+.fieldtable td.fielddoc {
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+.fieldtable td.fielddoc p:first-child {
+ margin-top: 0px;
+}
+
+.fieldtable td.fielddoc p:last-child {
+ margin-bottom: 2px;
+}
+
+.fieldtable tr:last-child td {
+ border-bottom: none;
+}
+
+.fieldtable th {
+ background-image: var(--memdef-title-gradient-image);
+ background-repeat:repeat-x;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+
+.tabsearch {
+ top: 0px;
+ left: 10px;
+ height: 36px;
+ background-image: var(--nav-gradient-image);
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
+}
+
+.navpath ul
+{
+ font-size: 11px;
+ background-image: var(--nav-gradient-image);
+ background-repeat:repeat-x;
+ background-position: 0 -5px;
+ height:30px;
+ line-height:30px;
+ color:var(--nav-text-normal-color);
+ border:solid 1px var(--nav-breadcrumb-border-color);
+ overflow:hidden;
+ margin:0px;
+ padding:0px;
+}
+
+.navpath li
+{
+ list-style-type:none;
+ float:left;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:var(--nav-breadcrumb-image);
+ background-repeat:no-repeat;
+ background-position:right;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.navelem a
+{
+ height:32px;
+ display:block;
+ outline: none;
+ color: var(--nav-text-normal-color);
+ font-family: var(--font-family-nav);
+ text-shadow: var(--nav-text-normal-shadow);
+ text-decoration: none;
+}
+
+.navpath li.navelem a:hover
+{
+ color: var(--nav-text-hover-color);
+ text-shadow: var(--nav-text-hover-shadow);
+}
+
+.navpath li.footer
+{
+ list-style-type:none;
+ float:right;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:none;
+ background-repeat:no-repeat;
+ background-position:right;
+ color: var(--footer-foreground-color);
+ font-size: 8pt;
+}
+
+
+div.summary
+{
+ float: right;
+ font-size: 8pt;
+ padding-right: 5px;
+ width: 50%;
+ text-align: right;
+}
+
+div.summary a
+{
+ white-space: nowrap;
+}
+
+table.classindex
+{
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
+}
+
+div.ingroups
+{
+ font-size: 8pt;
+ width: 50%;
+ text-align: left;
+}
+
+div.ingroups a
+{
+ white-space: nowrap;
+}
+
+div.header
+{
+ background-image: var(--header-gradient-image);
+ background-repeat:repeat-x;
+ background-color: var(--header-background-color);
+ margin: 0px;
+ border-bottom: 1px solid var(--header-separator-color);
+}
+
+div.headertitle
+{
+ padding: 5px 5px 5px 10px;
+}
+
+.PageDocRTL-title div.headertitle {
+ text-align: right;
+ direction: rtl;
+}
+
+dl {
+ padding: 0 0 0 0;
+}
+
+/*
+
+dl.section {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+dl.note {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #D0C000;
+}
+
+dl.warning, dl.attention {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #FF0000;
+}
+
+dl.pre, dl.post, dl.invariant {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #00D000;
+}
+
+dl.deprecated {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #505050;
+}
+
+dl.todo {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #00C0E0;
+}
+
+dl.test {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #3030E0;
+}
+
+dl.bug {
+ margin-left: -7px;
+ padding-left: 3px;
+ border-left: 4px solid;
+ border-color: #C08050;
+}
+
+*/
+
+dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
+ font-weight: bold !important;
+}
+
+dl.warning, dl.attention, dl.note, dl.deprecated, dl.bug,
+dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
+}
+
+dl.section dd {
+ margin-bottom: 2px;
+}
+
+dl.warning, dl.attention {
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
+}
+
+dl.warning dt, dl.attention dt {
+ color: var(--warning-color-hl);
+}
+
+dl.note, dl.remark {
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
+}
+
+dl.note dt, dl.remark dt {
+ color: var(--note-color-hl);
+}
+
+dl.todo {
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
+}
+
+dl.todo dt {
+ color: var(--todo-color-hl);
+}
+
+dl.test {
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
+}
+
+dl.test dt {
+ color: var(--test-color-hl);
+}
+
+dl.bug dt a {
+ color: var(--bug-color-hl) !important;
+}
+
+dl.bug {
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
+}
+
+dl.bug dt a {
+ color: var(--bug-color-hl) !important;
+}
+
+dl.deprecated {
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
+}
+
+dl.deprecated dt a {
+ color: var(--deprecated-color-hl) !important;
+}
+
+dl.section dd, dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
+ margin-inline-start: 0px;
+}
+
+dl.invariant, dl.pre, dl.post {
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
+}
+
+dl.invariant dt, dl.pre dt, dl.post dt {
+ color: var(--invariant-color-hl);
+}
+
+
+#projectrow
+{
+ height: 56px;
+}
+
+#projectlogo
+{
+ text-align: center;
+ vertical-align: bottom;
+ border-collapse: separate;
+}
+
+#projectlogo img
+{
+ border: 0px none;
+}
+
+#projectalign
+{
+ vertical-align: middle;
+ padding-left: 0.5em;
+}
+
+#projectname
+{
+ font-size: 200%;
+ font-family: var(--font-family-title);
+ margin: 0px;
+ padding: 2px 0px;
+}
+
+#projectbrief
+{
+ font-size: 90%;
+ font-family: var(--font-family-title);
+ margin: 0px;
+ padding: 0px;
+}
+
+#projectnumber
+{
+ font-size: 50%;
+ font-family: 50% var(--font-family-title);
+ margin: 0px;
+ padding: 0px;
+}
+
+#titlearea
+{
+ padding: 0px;
+ margin: 0px;
+ width: 100%;
+ border-bottom: 1px solid var(--title-separator-color);
+ background-color: var(--title-background-color);
+}
+
+.image
+{
+ text-align: center;
+}
+
+.dotgraph
+{
+ text-align: center;
+}
+
+.mscgraph
+{
+ text-align: center;
+}
+
+.plantumlgraph
+{
+ text-align: center;
+}
+
+.diagraph
+{
+ text-align: center;
+}
+
+.caption
+{
+ font-weight: bold;
+}
+
+dl.citelist {
+ margin-bottom:50px;
+}
+
+dl.citelist dt {
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
+}
+
+dl.citelist dd {
+ margin:2px 0 2px 72px;
+ padding:5px 0;
+}
+
+div.toc {
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
+}
+
+div.toc li {
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
+}
+
+div.toc h3 {
+ font: bold 12px/1.2 var(--font-family-toc);
+ color: var(--toc-header-color);
+ border-bottom: 0 none;
+ margin: 0;
+}
+
+div.toc ul {
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
+}
+
+div.toc li.level1 {
+ margin-left: 0px;
+}
+
+div.toc li.level2 {
+ margin-left: 15px;
+}
+
+div.toc li.level3 {
+ margin-left: 15px;
+}
+
+div.toc li.level4 {
+ margin-left: 15px;
+}
+
+span.emoji {
+ /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html
+ * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort;
+ */
+}
+
+span.obfuscator {
+ display: none;
+}
+
+.inherit_header {
+ font-weight: bold;
+ color: var(--inherit-header-color);
+ cursor: pointer;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.inherit_header td {
+ padding: 6px 0px 2px 5px;
+}
+
+.inherit {
+ display: none;
+}
+
+tr.heading h2 {
+ margin-top: 12px;
+ margin-bottom: 4px;
+}
+
+/* tooltip related style info */
+
+.ttc {
+ position: absolute;
+ display: none;
+}
+
+#powerTip {
+ cursor: default;
+ /*white-space: nowrap;*/
+ color: var(--tooltip-foreground-color);
+ background-color: var(--tooltip-background-color);
+ border: 1px solid var(--tooltip-border-color);
+ border-radius: 4px 4px 4px 4px;
+ box-shadow: var(--tooltip-shadow);
+ display: none;
+ font-size: smaller;
+ max-width: 80%;
+ opacity: 0.9;
+ padding: 1ex 1em 1em;
+ position: absolute;
+ z-index: 2147483647;
+}
+
+#powerTip div.ttdoc {
+ color: var(--tooltip-doc-color);
+ font-style: italic;
+}
+
+#powerTip div.ttname a {
+ font-weight: bold;
+}
+
+#powerTip a {
+ color: var(--tooltip-link-color);
+}
+
+#powerTip div.ttname {
+ font-weight: bold;
+}
+
+#powerTip div.ttdeci {
+ color: var(--tooltip-declaration-color);
+}
+
+#powerTip div {
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
+ line-height: 16px;
+}
+
+#powerTip:before, #powerTip:after {
+ content: "";
+ position: absolute;
+ margin: 0px;
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.w:after, #powerTip.w:before,
+#powerTip.e:after, #powerTip.e:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.nw:after, #powerTip.nw:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ border: solid transparent;
+ content: " ";
+ height: 0;
+ width: 0;
+ position: absolute;
+}
+
+#powerTip.n:after, #powerTip.s:after,
+#powerTip.w:after, #powerTip.e:after,
+#powerTip.nw:after, #powerTip.ne:after,
+#powerTip.sw:after, #powerTip.se:after {
+ border-color: rgba(255, 255, 255, 0);
+}
+
+#powerTip.n:before, #powerTip.s:before,
+#powerTip.w:before, #powerTip.e:before,
+#powerTip.nw:before, #powerTip.ne:before,
+#powerTip.sw:before, #powerTip.se:before {
+ border-color: rgba(128, 128, 128, 0);
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.nw:after, #powerTip.nw:before {
+ top: 100%;
+}
+
+#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
+ border-top-color: var(--tooltip-background-color);
+ border-width: 10px;
+ margin: 0px -10px;
+}
+#powerTip.n:before, #powerTip.ne:before, #powerTip.nw:before {
+ border-top-color: var(--tooltip-border-color);
+ border-width: 11px;
+ margin: 0px -11px;
+}
+#powerTip.n:after, #powerTip.n:before {
+ left: 50%;
+}
+
+#powerTip.nw:after, #powerTip.nw:before {
+ right: 14px;
+}
+
+#powerTip.ne:after, #powerTip.ne:before {
+ left: 14px;
+}
+
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ bottom: 100%;
+}
+
+#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
+ border-bottom-color: var(--tooltip-background-color);
+ border-width: 10px;
+ margin: 0px -10px;
+}
+
+#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
+ border-bottom-color: var(--tooltip-border-color);
+ border-width: 11px;
+ margin: 0px -11px;
+}
+
+#powerTip.s:after, #powerTip.s:before {
+ left: 50%;
+}
+
+#powerTip.sw:after, #powerTip.sw:before {
+ right: 14px;
+}
+
+#powerTip.se:after, #powerTip.se:before {
+ left: 14px;
+}
+
+#powerTip.e:after, #powerTip.e:before {
+ left: 100%;
+}
+#powerTip.e:after {
+ border-left-color: var(--tooltip-border-color);
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.e:before {
+ border-left-color: var(--tooltip-border-color);
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+#powerTip.w:after, #powerTip.w:before {
+ right: 100%;
+}
+#powerTip.w:after {
+ border-right-color: var(--tooltip-border-color);
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.w:before {
+ border-right-color: var(--tooltip-border-color);
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+@media print
+{
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
+}
+
+/* @group Markdown */
+
+table.markdownTable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.markdownTable td, table.markdownTable th {
+ border: 1px solid var(--table-cell-border-color);
+ padding: 3px 7px 2px;
+}
+
+table.markdownTable tr {
+}
+
+th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone {
+ background-color: var(--table-header-background-color);
+ color: var(--table-header-foreground-color);
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+th.markdownTableHeadLeft, td.markdownTableBodyLeft {
+ text-align: left
+}
+
+th.markdownTableHeadRight, td.markdownTableBodyRight {
+ text-align: right
+}
+
+th.markdownTableHeadCenter, td.markdownTableBodyCenter {
+ text-align: center
+}
+
+tt, code, kbd, samp
+{
+ display: inline-block;
+}
+/* @end */
+
+u {
+ text-decoration: underline;
+}
+
+details>summary {
+ list-style-type: none;
+}
+
+details > summary::-webkit-details-marker {
+ display: none;
+}
+
+details>summary::before {
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
+}
+
+details[open]>summary::before {
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
+}
+
+body {
+ scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
+}
+
+::-webkit-scrollbar {
+ background-color: var(--scrollbar-background-color);
+ height: 12px;
+ width: 12px;
+}
+::-webkit-scrollbar-thumb {
+ border-radius: 6px;
+ box-shadow: inset 0 0 12px 12px var(--scrollbar-thumb-color);
+ border: solid 2px transparent;
+}
+::-webkit-scrollbar-corner {
+ background-color: var(--scrollbar-background-color);
+}
+
diff --git a/doxygen.svg b/doxygen.svg
new file mode 100644
index 0000000..79a7635
--- /dev/null
+++ b/doxygen.svg
@@ -0,0 +1,28 @@
+
+
+
diff --git a/doxygen_crawl.html b/doxygen_crawl.html
new file mode 100644
index 0000000..734e19b
--- /dev/null
+++ b/doxygen_crawl.html
@@ -0,0 +1,256 @@
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/functions_func.html b/functions_func.html
new file mode 100644
index 0000000..ad86706
--- /dev/null
+++ b/functions_func.html
@@ -0,0 +1,199 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
1.10.0
+
+
+
diff --git a/graph_legend.html b/graph_legend.html
new file mode 100644
index 0000000..9639d24
--- /dev/null
+++ b/graph_legend.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+
The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
+ 1.10.0
+
+
+
diff --git a/graph_legend.md5 b/graph_legend.md5
new file mode 100644
index 0000000..da515da
--- /dev/null
+++ b/graph_legend.md5
@@ -0,0 +1 @@
+f74606a252eb303675caf37987d0b7af
\ No newline at end of file
diff --git a/graph_legend.png b/graph_legend.png
new file mode 100644
index 0000000..9fd8831
Binary files /dev/null and b/graph_legend.png differ
diff --git a/hierarchy.html b/hierarchy.html
new file mode 100644
index 0000000..5f05060
--- /dev/null
+++ b/hierarchy.html
@@ -0,0 +1,198 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
| ▼Cdict | |
| ▼Ctimeloopfe.common.nodes.DictNode | A node that is a dictionary of other nodes |
| ►Ctimeloopfe.common.base_specification.BaseSpecification | Base class for specifications in the Timeloop framework |
| Ctimeloopfe.common.base_specification.BaseSpecification | Base class for specifications in the Timeloop framework |
| ►Ctimeloopfe.v4.arch.Attributes | A class representing attributes for a node in the architecture |
| ►Ctimeloopfe.v4.arch.Branch | A branch in the architecture |
| ►Ctimeloopfe.v4.arch.Leaf | A leaf node in the architecture hierarchy |
| Ctimeloopfe.v4.arch.Spatial | A spatial configuration in a system architecture |
| Ctimeloopfe.v4.components.Action | Represents an action that a component can perform |
| Ctimeloopfe.v4.components.ComponentAttributes | Represents the attributes of a component |
| Ctimeloopfe.v4.components.Components | A collection of components |
| Ctimeloopfe.v4.components.CompoundComponent | Represents a compound component |
| Ctimeloopfe.v4.components.Subcomponent | A subcomponent |
| Ctimeloopfe.v4.components.SubcomponentAction | A subcomponent action |
| Ctimeloopfe.v4.components.SubcomponentActionGroup | A group of subactions taken by a particular subcomponent |
| ►Ctimeloopfe.v4.constraints.Constraint | A constraint in the system |
| Ctimeloopfe.v4.constraints.ConstraintGroup | A group of constraints |
| Ctimeloopfe.v4.constraints.Constraints | Class representing constraints |
| Ctimeloopfe.v4.globals.EnvironmentVariables | Dictionary of environment variables |
| Ctimeloopfe.v4.globals.Globals | Top-level Globals key |
| Ctimeloopfe.v4.mapper.Mapper | A mapper object that holds various attributes and settings for mapping operations in Timeloop |
| Ctimeloopfe.v4.mapspace.Mapspace | Top-level mapspace object |
| Ctimeloopfe.v4.problem.DataSpace | A data space object |
| Ctimeloopfe.v4.problem.Density | A Density object represents the density and distribution of a workload tensor |
| Ctimeloopfe.v4.problem.DensityList | A list of densities for each data space |
| Ctimeloopfe.v4.problem.Instance | An problem instance object |
| Ctimeloopfe.v4.problem.Problem | The top-level problem object in Timeloop |
| Ctimeloopfe.v4.problem.Shape | Problem shape object |
| Ctimeloopfe.v4.sparse_optimizations.ActionOptimization | An action optimization |
| Ctimeloopfe.v4.sparse_optimizations.ActionOptimizationOption | An action optimization option |
| Ctimeloopfe.v4.sparse_optimizations.ComputeOptimization | A compute optimization |
| Ctimeloopfe.v4.sparse_optimizations.RepresentationDataSpace | Contains the representation format for a data space |
| Ctimeloopfe.v4.sparse_optimizations.RepresentationFormat | A representation format sparse optimization |
| Ctimeloopfe.v4.sparse_optimizations.RepresentationRank | A representation rank |
| Ctimeloopfe.v4.sparse_optimizations.SparseOptimizationGroup | A group of sparse optimizations |
| Ctimeloopfe.v4.sparse_optimizations.SparseOptimizations | Top-level class for sparse optimizations |
| Ctimeloopfe.v4.variables.Variables | A top-level class for variables |
| ▼CException | |
| Ctimeloopfe.common.nodes.ParseError | Exception for nodes |
| Ctimeloopfe.common.processor.ProcessorError | Exception raised by processors |
| Ctimeloopfe.common.nodes.GrabParentAddMe | |
| ▼Clist | |
| ▼Ctimeloopfe.common.nodes.ListNode | A node that is a list of other nodes |
| ►Ctimeloopfe.common.nodes.CombineableListNode | A list node that can be combined with others by extending |
| ►Ctimeloopfe.common.nodes.FlatteningListNode | A list node that flattens lists of lists |
| Ctimeloopfe.v4.arch.ArchNodes | A collection of architectural nodes |
| Ctimeloopfe.v4.arch.Networks | A list of networks in the architecture |
| Ctimeloopfe.v4.components.ActionSubcomponentsList | A list of actions that may be taken as subactions of an action |
| Ctimeloopfe.v4.components.ActionsList | A list of actions for a component |
| Ctimeloopfe.v4.components.SubcomponentActionList | A list of subcomponent actions |
| Ctimeloopfe.v4.components.SubcomponentList | A list of subcomponents |
| Ctimeloopfe.v4.constraints.Permutation | A permutation of ranks |
| Ctimeloopfe.v4.constraints.ProblemDataspaceList | A list of problem dataspaces |
| Ctimeloopfe.v4.mapper.OptimizationMetrics | A list of optimization metrics including delay, energy, EDP, and last level accesses |
| Ctimeloopfe.v4.problem.ProblemDataspaceList | A list of data spaces in the problem |
| Ctimeloopfe.v4.sparse_optimizations.ActionOptimizationList | A list of action optimizations |
| Ctimeloopfe.v4.sparse_optimizations.ActionOptimizationOptionList | A list of action optimization options |
| Ctimeloopfe.v4.sparse_optimizations.RepresentationProblemDataspaceList | A list of representation problem dataspaces |
| Ctimeloopfe.v4.sparse_optimizations.RepresentationRankList | A list of ranks to be used in the representation format |
| Ctimeloopfe.v4.sparse_optimizations.SparseOptimizationsList | A list of sparse optimizations |
| ▼Cstr | |
| Ctimeloopfe.v4.constraints.Factor | A loop factor (e.g., P=1) |
| Ctimeloopfe.common.nodes.TypeSpecifier | Represents a type specifier for a node in the TimeloopFE library |
| Ctimeloopfe.common.nodes.Unspecified | Class to represent an unspecified value |
| ▼CABC | |
| ▼Ctimeloopfe.common.nodes.Node | Base class for all nodes in the hierarchy |
| Ctimeloopfe.common.nodes.DictNode | A node that is a dictionary of other nodes |
| Ctimeloopfe.common.nodes.ListNode | A node that is a list of other nodes |
| ►Ctimeloopfe.v4.arch.ArchNode | A node in the architecture hierarchy |
| ▼Ctimeloopfe.common.processor.Processor | Base class for all processors, which are used to modify the specification before it is passed to Accelergy/Timeloop |
| Ctimeloopfe.common.processor.References2CopiesProcessor | Converts references to copies in the specification |
| Ctimeloopfe.common.processor.SimpleProcessor | An example simple processor |
| Ctimeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor | Takes constraints from constraints lists and attaches them to objects in the architecture |
| Ctimeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor | Defines constraint macros to be used for simplifying constraint specification |
| Ctimeloopfe.v4.processors.dataspace2branch.Dataspace2BranchProcessor | Resolves which data spaces are kept in which branches |
| Ctimeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor | Enable the dummy table for Accelergy to placeholder energy/area |
| Ctimeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor | Optimizes permutation by pruning superfluous permutations |
| Ctimeloopfe.v4.processors.required_actions.RequiredActionsProcessor | Ensures that all components have actions defined for Accelergy Storage: |
| Ctimeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor | Takes sparse optimizations from sparse optimizations lists and attaches them to the architecture |
| Ctimeloopfe.v4.arch.Branch | A branch in the architecture |
| Ctimeloopfe.v4.arch.Component | A component in the architecture |
| Ctimeloopfe.v4.arch.Container | A container in the architecture |
| Ctimeloopfe.v4.arch.Leaf | A leaf node in the architecture hierarchy |
1.10.0
+
+
+
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..92f205a
--- /dev/null
+++ b/index.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
The Timeloop Front-End (TimeloopFE) is a Python front-end interface to the Timeloop infrastructure, which allows users to model tensor accelerators and explore the vast space of architectures, workloads, and mappings.
+TimeloopFE provides a rich Python interface, error checking, and automation tools. With closely-aligned Python and YAML interfaces, TimeloopFE is designed to enable easy design space exploration and automation.
+First, ensure that Timeloop and Accelergy are installed following the Timeloop+Accelergy install instructions.
+To install timeloopfe, run the following commands:
Tutorials and examples available in the Timeloop and Accelergy exercises repository. In this repository, examples can be found in the workspace/baseline_designs directory and tutorials can be found in the workspace/exercises directory.
TimeloopFE interface provides two primary functions: - Input file gathering & error checking - Python interface for design space exploration
Please visit the Timeloop and Accelergy exercises repository for more examples and tutorials.
+ 1.10.0
+
+
+
diff --git a/inherit_graph_0.map b/inherit_graph_0.map
new file mode 100644
index 0000000..0ebd684
--- /dev/null
+++ b/inherit_graph_0.map
@@ -0,0 +1,188 @@
+
diff --git a/inherit_graph_0.md5 b/inherit_graph_0.md5
new file mode 100644
index 0000000..55b8731
--- /dev/null
+++ b/inherit_graph_0.md5
@@ -0,0 +1 @@
+a60b1aed71be6dfb805f62f909722ccb
\ No newline at end of file
diff --git a/inherit_graph_0.png b/inherit_graph_0.png
new file mode 100644
index 0000000..757b481
Binary files /dev/null and b/inherit_graph_0.png differ
diff --git a/inherit_graph_1.map b/inherit_graph_1.map
new file mode 100644
index 0000000..a24bdfd
--- /dev/null
+++ b/inherit_graph_1.map
@@ -0,0 +1,7 @@
+
diff --git a/inherit_graph_1.md5 b/inherit_graph_1.md5
new file mode 100644
index 0000000..41f9adb
--- /dev/null
+++ b/inherit_graph_1.md5
@@ -0,0 +1 @@
+68ae1359afa8481405c192d72b7e1e95
\ No newline at end of file
diff --git a/inherit_graph_1.png b/inherit_graph_1.png
new file mode 100644
index 0000000..02c7212
Binary files /dev/null and b/inherit_graph_1.png differ
diff --git a/inherit_graph_2.map b/inherit_graph_2.map
new file mode 100644
index 0000000..e858393
--- /dev/null
+++ b/inherit_graph_2.map
@@ -0,0 +1,5 @@
+
diff --git a/inherit_graph_2.md5 b/inherit_graph_2.md5
new file mode 100644
index 0000000..2f6a750
--- /dev/null
+++ b/inherit_graph_2.md5
@@ -0,0 +1 @@
+db69837645a13f8d30b39a83377e4be8
\ No newline at end of file
diff --git a/inherit_graph_2.png b/inherit_graph_2.png
new file mode 100644
index 0000000..cf1a2f9
Binary files /dev/null and b/inherit_graph_2.png differ
diff --git a/inherit_graph_3.map b/inherit_graph_3.map
new file mode 100644
index 0000000..6e3b46c
--- /dev/null
+++ b/inherit_graph_3.map
@@ -0,0 +1,3 @@
+
diff --git a/inherit_graph_3.md5 b/inherit_graph_3.md5
new file mode 100644
index 0000000..cd7ca69
--- /dev/null
+++ b/inherit_graph_3.md5
@@ -0,0 +1 @@
+cdad98606f63a13aa3d9165b65a68fbd
\ No newline at end of file
diff --git a/inherit_graph_3.png b/inherit_graph_3.png
new file mode 100644
index 0000000..61448d8
Binary files /dev/null and b/inherit_graph_3.png differ
diff --git a/inherit_graph_4.map b/inherit_graph_4.map
new file mode 100644
index 0000000..b27dd08
--- /dev/null
+++ b/inherit_graph_4.map
@@ -0,0 +1,3 @@
+
diff --git a/inherit_graph_4.md5 b/inherit_graph_4.md5
new file mode 100644
index 0000000..5406c92
--- /dev/null
+++ b/inherit_graph_4.md5
@@ -0,0 +1 @@
+7b3b1346468fc6338023afa9ec425997
\ No newline at end of file
diff --git a/inherit_graph_4.png b/inherit_graph_4.png
new file mode 100644
index 0000000..84220c3
Binary files /dev/null and b/inherit_graph_4.png differ
diff --git a/inherit_graph_5.map b/inherit_graph_5.map
new file mode 100644
index 0000000..1a5f976
--- /dev/null
+++ b/inherit_graph_5.map
@@ -0,0 +1,3 @@
+
diff --git a/inherit_graph_5.md5 b/inherit_graph_5.md5
new file mode 100644
index 0000000..1ca7faf
--- /dev/null
+++ b/inherit_graph_5.md5
@@ -0,0 +1 @@
+60a2e3225da9f347240e6cb5beb0f9c6
\ No newline at end of file
diff --git a/inherit_graph_5.png b/inherit_graph_5.png
new file mode 100644
index 0000000..610b44f
Binary files /dev/null and b/inherit_graph_5.png differ
diff --git a/inherits.html b/inherits.html
new file mode 100644
index 0000000..2b872df
--- /dev/null
+++ b/inherits.html
@@ -0,0 +1,308 @@
+
+
+
+
+
+
+
+|
+ TimeloopFE
+
+ |
+
+
+ |
+
+ |
+
+ |
+
+ |
+
+ |
+
+ |
1.10.0
+
+
+
diff --git a/jquery.js b/jquery.js
new file mode 100644
index 0000000..1dffb65
--- /dev/null
+++ b/jquery.js
@@ -0,0 +1,34 @@
+/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */
+!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0
