kups.core.data.table
¶
Table
¶
Bases: Batched, Generic[TKey, TData]
Entity-relation table with a primary key column and a data column.
A Table[TKey, TData] is a keyed data container analogous to a database
table. keys is the primary key column (unique, sorted) and data
is the value column — a pytree of arrays whose leaves share a leading
dimension equal to len(keys).
Accessing data:
.datagives the raw value pytree, aligned to this table's own keys. Use for operations within a single key space.-
table[index]whereindex: Index[TKey]performs a foreign-key lookup — gathering rows by key, analogous to a SQL JOIN. Use this whenever data must be broadcast across key spaces::# system → particle: broadcast system data to each particle per_particle = systems[particles.data.system]
# particle → edge: broadcast particle data to each edge per_edge = particles[edges.indices]
Any Index[TKey] leaf inside another table's data acts as a
foreign key referencing this table's primary keys.
Attributes:
| Name | Type | Description |
|---|---|---|
keys |
tuple[TKey, ...]
|
Primary key column — unique sorted tuple, one entry per row. |
data |
TData
|
Value column — pytree of arrays with leading dimension |
Source code in src/kups/core/data/table.py
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 95 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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 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 250 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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 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 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 | |
cls
property
¶
Key type, always available even for empty tables.
size
property
¶
Number of entries along the leading axis (same as len()).
__contains__(key)
¶
__getitem__(index)
¶
Retrieve data entries selected by index.
Source code in src/kups/core/data/table.py
__len__()
¶
arange(data, *, label=int)
classmethod
¶
Create a Table with keys label(0), label(1), ..., label(n-1).
Source code in src/kups/core/data/table.py
at(index, *, args=None)
¶
Return a bound lens focused on entries selected by index.
Source code in src/kups/core/data/table.py
broadcast(*items)
staticmethod
¶
broadcast(
item1: Table[L, D1],
item2: Table[L, D2],
item3: Table[L, D3],
) -> tuple[Table[L, D1], Table[L, D2], Table[L, D3]]
Broadcast Table containers to a common leading-axis size.
Analogous to NumPy broadcasting: all inputs must share the same
key type, and each must either have the maximum size among inputs
or have exactly size 1. Size-1 tables are expanded by repeating
their single entry along the leading axis. Requires integer-based
keys (e.g. SystemId) so that the expanded key range
0 .. max_size-1 can be generated.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
*items
|
Table
|
One or more |
()
|
Returns:
| Type | Description |
|---|---|
Table
|
A tuple of |
...
|
same leading-axis size and |
Raises:
| Type | Description |
|---|---|
AssertionError
|
If key types differ, sizes are not
broadcastable, or keys of full-size tables are not
|
Example::
>>> scalars = Table.arange(jnp.array([1.0]), label=SystemId)
>>> vectors = Table.arange(jnp.array([1, 2, 3]), label=SystemId)
>>> s, v = Table.broadcast(scalars, vectors)
>>> len(s) # 3, was broadcast from 1
Source code in src/kups/core/data/table.py
broadcast_to(source, target)
staticmethod
¶
Broadcast source to match the size of target.
Convenience wrapper around Table.broadcast(source, target)[0].
source must either already have the same length as target
or have length 1 (in which case it is repeated).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source
|
Table[L, D]
|
The |
required |
target
|
Table[L, Any]
|
The |
required |
Returns:
| Type | Description |
|---|---|
Table[L, D]
|
A |
Table[L, D]
|
|
Source code in src/kups/core/data/table.py
join(base, *others)
staticmethod
¶
join(
base: Table[L, D],
o1: Table[L, T1],
o2: Table[L, T2],
o3: Table[L, T3],
) -> Table[L, tuple[D, T1, T2, T3]]
Join multiple Table objects on matching keys into tuple data.
Performs a SQL-style JOIN on key equality. All arguments must
share the same key set. If keys appear in a different order, the
others are reindexed to match base's key ordering before
their data is combined.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
base
|
Table
|
The reference |
required |
*others
|
Table
|
One or more additional |
()
|
Returns:
| Type | Description |
|---|---|
Table
|
A new |
Table
|
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If fewer than one |
Example::
>>> species = Table(("H", "O"), jnp.array([1, 8]))
>>> masses = Table(("O", "H"), jnp.array([16.0, 1.0]))
>>> joined = Table.join(species, masses)
>>> joined.data # (array([1, 8]), array([1.0, 16.0]))
Source code in src/kups/core/data/table.py
map_data(fn)
¶
Apply fn to data, keeping the same keys.
match(*groups)
staticmethod
¶
Align leaf Index keys across multiple Table containers.
Ensures that all Index leaves of the same key type share an
identical key vocabulary. For each key type present across the
inputs, the key tuples are merged (deduplicated, sorted) and
every Index leaf of that type is updated to use the shared
vocabulary via Index.update_labels.
This is typically called before operations that require
element-wise comparison of indices across tables (e.g. before
Table.union).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
*groups
|
Table
|
One or more |
()
|
Returns:
| Type | Description |
|---|---|
tuple[Table, ...] | Table
|
A tuple of |
tuple[Table, ...] | Table
|
or a single |
Source code in src/kups/core/data/table.py
set_data(data)
¶
slice(start=0, end=None, step=1)
¶
Slice along the leading axis, preserving the corresponding keys.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start
|
int
|
Start index (default 0). |
0
|
end
|
int | None
|
End index (default |
None
|
step
|
int
|
Step size (default 1). |
1
|
Source code in src/kups/core/data/table.py
subset(index)
¶
Extract a subset of rows, re-keying as (0, 1, ...).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
index
|
Index[TKey]
|
Rows to extract (must reference |
required |
Returns:
| Type | Description |
|---|---|
Self
|
New container with freshly numbered keys. |
Source code in src/kups/core/data/table.py
transform(fn)
staticmethod
¶
Lift a function on raw data to operate on Table containers.
Returns a wrapper that unpacks .data from each Table
argument, calls fn, and re-wraps the result in a new
Table with the same keys. All inputs must share identical
keys.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fn
|
Callable[..., Any]
|
A callable |
required |
Returns:
| Type | Description |
|---|---|
Callable[..., Any]
|
A callable |
Callable[..., Any]
|
that applies |
Example::
>>> double = Table.transform(lambda x: x * 2)
>>> t = Table.arange(jnp.array([1, 2, 3]), label=SystemId)
>>> double(t).data # array([2, 4, 6])
Source code in src/kups/core/data/table.py
union(*groups)
staticmethod
¶
union(
item1: Sequence[Table[L1, D1]],
item2: Sequence[Table[L2, D2]],
) -> tuple[Table[L1, D1], Table[L2, D2]]
Concatenate multiple Table sequences (SQL UNION ALL).
Each positional argument is a sequence of Table objects that
share the same key type and schema. Tables within each sequence
are concatenated along the leading axis. Integer-based sentinel
keys (e.g. SystemId, ParticleId) are offset-shifted per
source so that the resulting keys are globally unique. Leaf
Index objects nested inside data are similarly remapped.
When multiple groups are given, leaf Index keys are first
aligned across corresponding tables via Table.match so that
cross-references (e.g. particles pointing at system ids) remain
consistent after concatenation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
*groups
|
Sequence[Table]
|
One or more sequences of |
()
|
Returns:
| Type | Description |
|---|---|
tuple[Table, ...] | Table
|
A single |
tuple[Table, ...] | Table
|
tuple of |
Raises:
| Type | Description |
|---|---|
AssertionError
|
If group lengths differ or duplicate key types appear across groups. |
Example::
>>> p0 = Table.arange(jnp.array([1, 8]), label=ParticleId)
>>> p1 = Table.arange(jnp.array([6, 7]), label=ParticleId)
>>> merged = Table.union([p0, p1])
>>> len(merged) # 4
>>> merged.keys # (ParticleId(0), ..., ParticleId(3))
Source code in src/kups/core/data/table.py
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 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 | |
update(index, data, **kwargs)
¶
Write data into rows selected by index.
Source code in src/kups/core/data/table.py
update_if(accept, indices, new_data)
¶
Conditionally update rows based on a per-element accept mask.
The accept mask is resolved against the indices found in both
self[indices] and new_data, and the union of the two is
used to select which entries to write.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
accept
|
Table[L, Array]
|
Per-key boolean acceptance indexed by |
required |
indices
|
Index[TKey]
|
Target slot positions in |
required |
new_data
|
D
|
Proposed replacement data (same structure as subset). |
required |
Returns:
| Type | Description |
|---|---|
Table[TKey, D]
|
Updated container with accepted entries written. |