Class swarmauri_standard.seminorms.CoordinateProjectionSeminorm.CoordinateProjectionSeminorm
swarmauri_standard.seminorms.CoordinateProjectionSeminorm.CoordinateProjectionSeminorm
CoordinateProjectionSeminorm(projection_indices)
Bases: SeminormBase
Seminorm via projection onto a subset of coordinates.
This seminorm ignores certain components of the vector, resulting in possible degeneracy. It projects the input onto a specified subset of coordinates and computes the norm only on those coordinates.
Attributes
type : Literal["CoordinateProjectionSeminorm"] The type identifier for this seminorm projection_indices : Set[int] The set of indices to project onto
Initialize the coordinate projection seminorm.
Parameters
projection_indices : Set[int] The set of indices to project onto. These are the components that will be considered when computing the seminorm, all other components will be ignored.
Raises
ValueError If projection_indices is empty
Source code in swarmauri_standard/seminorms/CoordinateProjectionSeminorm.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
type
class-attribute
instance-attribute
type = 'CoordinateProjectionSeminorm'
projection_indices
instance-attribute
projection_indices = projection_indices
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(x)
Compute the seminorm of the input by projecting onto specified coordinates.
Parameters
x : InputType The input to compute the seminorm for. Can be a vector, matrix, sequence, or numpy array.
Returns
float The seminorm value (non-negative real number)
Raises
TypeError If the input type is not supported ValueError If the computation cannot be performed on the given input
Source code in swarmauri_standard/seminorms/CoordinateProjectionSeminorm.py
58 59 60 61 62 63 64 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 |
|
check_triangle_inequality
check_triangle_inequality(x, y)
Check if the triangle inequality property holds for the given inputs.
The triangle inequality states that: ||x + y|| ≤ ||x|| + ||y||
Parameters
x : InputType First input to check y : InputType Second input to check
Returns
bool True if the triangle inequality holds, False otherwise
Raises
TypeError If the input types are not supported or compatible ValueError If the check cannot be performed on the given inputs
Source code in swarmauri_standard/seminorms/CoordinateProjectionSeminorm.py
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
|
check_scalar_homogeneity
check_scalar_homogeneity(x, alpha)
Check if the scalar homogeneity property holds for the given input and scalar.
The scalar homogeneity states that: ||αx|| = |α|·||x||
Parameters
x : InputType The input to check alpha : T The scalar to multiply by
Returns
bool True if scalar homogeneity holds, False otherwise
Raises
TypeError If the input type is not supported ValueError If the check cannot be performed on the given input
Source code in swarmauri_standard/seminorms/CoordinateProjectionSeminorm.py
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
|
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 |
|