TypedLogicArray<T extends Logic, V> class
A multidimensional logic array with hardware leaves of type T and
semantic values of type V.
This is a LogicStructure because an array owns a hierarchy of child signals, just like LogicArray. It is therefore indirectly a Logic through the structure's packed representation, rather than a scalar Logic whose wire is subdivided into array elements.
LogicArray directly extends TypedLogicArray<Logic, LogicValue> as
the ordinary-Logic specialization, inheriting its typed-array API.
TypedLogicArray extends the internal BaseLogicArray, where the shared
array metadata and traversal live, while T preserves the type at the
declared array boundary.
value and previousValue preserve V through TypedLogicValueArray
snapshots. Standard Logic.changed events remain packed
LogicValueChanged events.
The optional dimensionNames constructor argument is construction metadata
used when naming typed-array hierarchy members and when cloning. It is not
exposed as a public axis-metadata property; ordinary LogicArray naming
continues to follow its existing generated-name convention.
- Inheritance
-
- Object
- LogicStructure
- TypedLogicArray
- Implementers
- Available extensions
Constructors
-
TypedLogicArray(List<
int> dimensions, TypedLogicArrayElementBuilder<T> elementBuilder, {LogicValueCodec<V> ? valueCodec, TypedLogicArrayElementCompatibility<T> ? elementCompatibility, List<String> ? dimensionNames, String? name, Naming? naming, int numUnpackedDimensions = 0}) -
Creates an array with
dimensionsand typed leaves fromelementBuilder. -
TypedLogicArray.fromScalar(T source, {required LogicValueCodec<
V> valueCodec, String? name}) -
Creates a connected rank-zero view of
source.factory
Properties
-
arrayElements
→ List<
T> -
Typed elements reached after traversing exactly
dimensionsarray levels.no setter - arrayIndex → int?
-
The index within the immediate parent array, if there is one.
no setterinherited
-
changed
→ Stream<
LogicValueChanged> -
A Stream of
LogicValueChangedevents which triggers at most once per Simulator tick, iff the value of the Logic has changed.latefinalinherited -
dimensions
→ List<
int> -
The number of elements at each level of the array, starting from the most
significant outermost level.
finalinherited
-
dstConnections
→ Iterable<
Logic> -
An Iterable of all
Logics that are being directly driven bythis.no setterinherited -
elements
→ List<
Logic> -
All elements of this structure.
latefinalinherited
- elementWidth → int
-
The width of leaf elements in this array.
finalinherited
-
glitch
→ SynchronousEmitter<
LogicValueChanged> -
A stream of
LogicValueChangedevents for every time the signal transitions at any time during a Simulator tick.latefinalinherited - hasConsts → bool
-
Indicates whether this structure contains a Const at any depth.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasNets → bool
-
Indicates whether this structure or any of its elements isNet.
no setterinherited
-
indexedElements
→ Iterable<
(List< int> , T)> -
Array elements paired with their row-major multidimensional indices.
no setter
- isArrayMember → bool
-
Whether the immediate parentStructure is a
BaseLogicArray.no setterinherited - isEmpty → bool
-
Whether this signal has no bits.
no setterinherited
- isInOut → bool
-
Returns true iff this signal is an inOut of its parent Module.
latefinalinherited
- isInput → bool
-
Returns true iff this signal is an input of its parent Module.
latefinalinherited
- isNet → bool
-
finalinherited
- isOutput → bool
-
Returns true iff this signal is an output of its parent Module.
latefinalinherited
- isPort → bool
-
Returns true iff this signal is an input, output, or inOut of its parent
Module.
latefinalinherited
-
leafElements
→ List<
Logic> -
A list of all leaf-level elements at the deepest hierarchy of this
structure provided in index order.
latefinalinherited
-
majorSlices
→ Iterable<
TypedLogicArray< T, V> > -
Immediate typed child arrays along the first dimension.
no setter
- name → String
-
The name of this signal.
finalinherited
- naming → Naming
-
finalinherited
-
negedge
→ Stream<
LogicValueChanged> -
A Stream of
LogicValueChangedevents which triggers at most once per Simulator tick, iff the value of the Logic has changed from1to0.no setterinherited -
nextChanged
→ Future<
LogicValueChanged> -
Triggers at most once, the next time that this Logic changes
value at the end of a Simulator tick.
no setterinherited
-
nextNegedge
→ Future<
LogicValueChanged> -
Triggers at most once, the next time that this Logic changes
value at the end of a Simulator tick from
1to0.no setterinherited -
nextPosedge
→ Future<
LogicValueChanged> -
Triggers at most once, the next time that this Logic changes
value at the end of a Simulator tick from
0to1.no setterinherited - numUnpackedDimensions → int
-
The number of
dimensionswhich should be treated as "unpacked", starting from the outermost (first) elements ofdimensions.finalinherited - packed → Logic
-
Packs all elements into one flattened Logic bus.
no setterinherited
- parentModule → Module?
-
The Module that this Logic exists within.
no setterinherited
- parentStructure → LogicStructure?
-
If this is a part of a LogicStructure, the structure which this is
a part of. Otherwise,
null.no setterinherited -
posedge
→ Stream<
LogicValueChanged> -
A Stream of
LogicValueChangedevents which triggers at most once per Simulator tick, iff the value of the Logic has changed from0to1.no setterinherited -
previousValue
→ TypedLogicValueArray<
V> ? -
The value of this signal before the most recent Simulator.tick had
completed. It will be
nullbefore the first tick after this signal is created.no setteroverride - reversed → Logic
-
Returns a version of this Logic with the bit order reversed.
latefinalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scalar → T
-
The typed leaf of a rank-zero array.
no setter
- srcConnection → Logic?
-
A LogicStructure never has a direct source driving it, only its
elements do, so always returns
null.no setterinherited -
srcConnections
→ Iterable<
Logic> -
All
Logics drivingthis, if any.no setterinherited - structureName → String
-
Returns the name relative to the parentStructure-defined hierarchy, if
one exists. Otherwise, this is the same as name.
no setterinherited
-
value
→ TypedLogicValueArray<
V> -
The current active value of this signal.
no setteroverride
-
valueCodec
→ LogicValueCodec<
V> -
Converts each element's packed bits to and from its semantic value type.
final
- width → int
-
The number of bits in this signal.
latefinalinherited
Methods
-
abs(
) → Logic -
Calculates the absolute value of a signal, assuming that the
number is a two's complement.
inherited
-
and(
) → Logic -
Unary AND.
inherited
-
assignSubset(
List< Logic> updatedSubset, {int start = 0}) → void -
Performs an assignment operation on a portion this signal to be driven by
updatedSubset. Each index ofupdatedSubsetwill be assigned to drive the corresponding index, plusstart, of this signal.inherited -
at(
List< int> indices) → T -
Returns the array element at multidimensional
indices. -
clone(
{String? name}) → TypedLogicArray< T, V> - Creates an array with the same shape and element representation.
-
cloneTyped(
{String? name}) → LogicType -
Available on LogicType, provided by the TypedLogicUtilities extension
Equivalent to Logic.clone, preserving the receiver's static type and any declared payload type and semantic shape. -
createClone(
{String? name, Naming? naming, int? numUnpackedDimensions}) → TypedLogicArray< T, V> - Creates a clone while allowing subclasses to preserve their runtime type.
-
decr(
{Logic s(Logic)?, dynamic val = 1}) → Conditional -
Decrements each element of elements using Logic.decr.
inherited
-
divAssign(
dynamic val, {Logic s(Logic)?}) → Conditional -
Divide-assigns each element of elements using Logic.divAssign.
inherited
-
eq(
dynamic other) → Logic -
Logical equality.
inherited
-
getRange(
int startIndex, [int? endIndex]) → Logic -
Returns a subset Logic. It is inclusive of
startIndex, exclusive ofendIndex.inherited -
gets(
Logic other) → void -
Connects this Logic directly to be driven by
other.inherited -
gt(
dynamic other) → Logic -
Greater-than.
inherited
-
gte(
dynamic other) → Logic -
Greater-than-or-equal-to.
inherited
-
incr(
{Logic s(Logic)?, dynamic val = 1}) → Conditional -
Increments each element of elements using Logic.incr.
inherited
-
inject(
dynamic val, {bool fill = false}) → void -
Injects a value onto this signal in the current Simulator tick.
inherited
-
isIn(
List list) → Logic -
Returns
1(of width=1) if the Logic calling this function is inlist. Else0(of width=1) if not present.inherited -
lt(
dynamic other) → Logic -
Less-than.
inherited
-
lte(
dynamic other) → Logic -
Less-than-or-equal-to.
inherited
-
makeUnassignable(
{String? reason}) → void -
Makes it so that this signal cannot be assigned by any full (
<=) or conditional (<) assignment.inherited -
mulAssign(
dynamic val, {Logic s(Logic)?}) → Conditional -
Multiply-assigns each element of elements using Logic.mulAssign.
inherited
-
named(
String name, {Naming? naming}) → TypedLogicArray< T, V> -
Creates and connects an array with the requested
name. -
namedTyped(
String name, {Naming? naming}) → LogicType -
Available on LogicType, provided by the TypedLogicUtilities extension
Creates a named driveable alias while preserving the static result type. -
neq(
dynamic other) → Logic -
Logical inequality.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
or(
) → Logic -
Unary OR.
inherited
-
pad(
{required int atLeast, bool lsbs = true, bool fill = false}) → Logic -
Returns a Logic that is at least
atLeastbits wide by inserting the minimum number of bits, each equal tofill, at the least significant end (lsbstrue) or the most significant end (lsbsfalse).inherited -
pow(
dynamic exponent) → Logic -
Power operation
inherited
-
put(
dynamic val, {bool fill = false}) → void -
Puts a value
valonto this signal, which may or may not be picked up for changed in this Simulator tick.inherited -
replicate(
int multiplier) → Logic -
Returns a replicated signal using ReplicationOp with new width =
this.width *
multiplierinherited -
selectFrom<
LogicType extends Logic> (List< LogicType> busList, {dynamic defaultValue, LogicType outputGenerator({String? name})?, String name = 'selectFrom'}) → LogicType -
Performs a Logic
indexbased selection onbusList.inherited -
signExtend(
int newWidth) → Logic -
Returns a new Logic width width
newWidthwhere new bits added are sign bits as the most significant bits. The sign is determined using two's complement, so it takes the most significant bit of the original signal and extends with that.inherited -
slice(
int endIndex, int startIndex) → Logic -
Accesses a subset of this signal from
startIndextoendIndex, both inclusive.inherited -
split(
List< int> widths) → List<Logic> -
Splits this signal into LSB-first chunks with the provided
widths.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
transpose(
{List< int> ? axes, String? name}) → TypedLogicArray<T, V> -
Returns a live view with dimensions reordered by
axes. -
withSet(
int startIndex, Logic update) → Logic -
Returns a copy of this Logic with the bits starting from
startIndexup untilstartIndex+update.widthset toupdateinstead of their original value.inherited -
xor(
) → Logic -
Unary XOR.
inherited
-
zeroExtend(
int newWidth) → Logic -
Returns a Logic with width
newWidthwhere new bits added are zeros as the most significant bits.inherited
Operators
-
operator %(
dynamic other) → Logic -
Modulo operation.
inherited
-
operator &(
Logic other) → Logic -
Logical bitwise AND.
inherited
-
operator *(
dynamic other) → Logic -
Multiplication.
inherited
-
operator +(
dynamic other) → Logic -
Addition.
inherited
-
operator -(
dynamic other) → Logic -
Subtraction.
inherited
-
operator /(
dynamic other) → Logic -
Division.
inherited
-
operator <(
dynamic other) → Conditional -
Conditional assignment operator.
inherited
-
operator <<(
dynamic other) → Logic -
Logical left-shift.
inherited
-
operator <=(
Logic other) → void -
Connects this Logic directly to another Logic.
inherited
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator >(
dynamic other) → Logic -
Greater-than.
inherited
-
operator >=(
dynamic other) → Logic -
Greater-than-or-equal-to.
inherited
-
operator >>(
dynamic other) → Logic -
Arithmetic right-shift.
inherited
-
operator >>>(
dynamic other) → Logic -
Logical right-shift.
inherited
-
operator [](
dynamic index) → Logic -
Accesses the
indexth bit of this signal.inherited -
operator ^(
Logic other) → Logic -
Logical bitwise XOR.
inherited
-
operator |(
Logic other) → Logic -
Logical bitwise OR.
inherited
-
operator ~(
) → Logic -
Logical bitwise NOT.
inherited