Class swarmauri_base.matrices.MatrixBase.MatrixBase
swarmauri_base.matrices.MatrixBase.MatrixBase
Bases: IMatrix
, ComponentBase
Base class for matrix operations.
Provides abstract implementations for matrix operations including addition, subtraction, multiplication, division, and other common matrix functions. This class serves as a foundation for concrete matrix implementations.
Attributes
resource : Optional[str] The resource type of this component, defaults to MATRIX
shape
property
shape
Get the shape of the matrix.
Returns
Tuple[int, int] The dimensions of the matrix as (rows, columns)
Raises
NotImplementedError This property must be implemented by subclasses
dtype
property
dtype
Get the data type of the matrix elements.
Returns
type The data type of the elements
Raises
NotImplementedError This property must be implemented by subclasses
type
class-attribute
instance-attribute
type = 'ComponentBase'
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'
reshape
reshape(shape)
Reshape the matrix to the specified dimensions.
Parameters
shape : Tuple[int, int] The new dimensions as (rows, columns)
Returns
IMatrix A reshaped matrix
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/matrices/MatrixBase.py
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
tolist
tolist()
Convert the matrix to a nested list.
Returns
List[List[T]] A list of lists representing the matrix
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/matrices/MatrixBase.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
|
row
row(index)
Get a specific row of the matrix.
Parameters
index : int The row index
Returns
IVector The specified row as a vector
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/matrices/MatrixBase.py
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
|
column
column(index)
Get a specific column of the matrix.
Parameters
index : int The column index
Returns
IVector The specified column as a vector
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/matrices/MatrixBase.py
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
|
transpose
transpose()
Transpose the matrix.
Returns
IMatrix The transposed matrix
Raises
NotImplementedError This method must be implemented by subclasses
Source code in swarmauri_base/matrices/MatrixBase.py
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
|
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 |
|