Class swarmauri_base.inner_products.InnerProductBase.InnerProductBase
swarmauri_base.inner_products.InnerProductBase.InnerProductBase
Bases: IInnerProduct
, ComponentBase
Abstract base class implementing partial methods for inner product calculations.
This class provides a base implementation of all abstract methods defined in the IInnerProduct interface. It serves as a foundation for specific inner product implementations, offering common functionality and ensuring adherence to the interface contract.
Attributes
resource : str The resource type identifier, defaulting to INNER_PRODUCT
type
class-attribute
instance-attribute
type = 'InnerProductBase'
model_config
class-attribute
instance-attribute
model_config = ConfigDict(
extra="allow", arbitrary_types_allowed=True
)
id
class-attribute
instance-attribute
id = Field(default_factory=generate_id)
members
class-attribute
instance-attribute
members = None
owners
class-attribute
instance-attribute
owners = None
host
class-attribute
instance-attribute
host = None
default_logger
class-attribute
default_logger = None
logger
class-attribute
instance-attribute
logger = None
name
class-attribute
instance-attribute
name = None
version
class-attribute
instance-attribute
version = '0.1.0'
compute
compute(a, b)
Compute the inner product between two objects.
Parameters
a : Union[Vector, Matrix, Callable] The first object for inner product calculation b : Union[Vector, Matrix, Callable] The second object for inner product calculation
Returns
float The inner product value
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/inner_products/InnerProductBase.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
|
check_conjugate_symmetry
check_conjugate_symmetry(a, b)
Check if the inner product satisfies the conjugate symmetry property: = * (complex conjugate).
Parameters
a : Union[Vector, Matrix, Callable] The first object b : Union[Vector, Matrix, Callable] The second object
Returns
bool True if conjugate symmetry holds, False otherwise
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/inner_products/InnerProductBase.py
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
|
check_linearity_first_argument
check_linearity_first_argument(a1, a2, b, alpha, beta)
Check if the inner product satisfies linearity in the first argument:
Parameters
a1 : Union[Vector, Matrix, Callable] First component of the first argument a2 : Union[Vector, Matrix, Callable] Second component of the first argument b : Union[Vector, Matrix, Callable] The second object alpha : float Scalar multiplier for a1 beta : float Scalar multiplier for a2
Returns
bool True if linearity in the first argument holds, False otherwise
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/inner_products/InnerProductBase.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
|
check_positivity
check_positivity(a)
Check if the inner product satisfies the positivity property: >= 0 and = 0 iff a = 0.
Parameters
a : Union[Vector, Matrix, Callable] The object to check positivity for
Returns
bool True if positivity holds, False otherwise
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/inner_products/InnerProductBase.py
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
|
register_model
classmethod
register_model()
Decorator to register a base model in the unified registry.
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the model class.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
register_type
classmethod
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
PARAMETER | DESCRIPTION |
---|---|
resource_type
|
The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used.
TYPE:
|
type_name
|
An optional custom type name for the subtype.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the subtype.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |
|
model_validate_toml
classmethod
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
model_dump_toml
model_dump_toml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
model_validate_yaml
classmethod
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
model_dump_yaml
model_dump_yaml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
model_post_init
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
23 24 25 26 27 28 |
|