RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/foreign/SequenceLayout.html below:

SequenceLayout (Java SE 21 & JDK 21)

All Superinterfaces:: MemoryLayout^PREVIEW

SequenceLayout is a preview API of the Java platform.

A compound layout that denotes a homogeneous repetition of a given

element layout

. The repetition count is said to be the sequence layout's

element count

. A sequence layout can be thought of as a struct layout where the sequence layout's element layout is repeated a number of times that is equal to the sequence layout's element count. In other words this layout:

MemoryLayout.sequenceLayout(3, ValueLayout.JAVA_INT.withOrder(ByteOrder.BIG_ENDIAN));

is equivalent to the following layout:

MemoryLayout.structLayout(
    ValueLayout.JAVA_INT.withOrder(ByteOrder.BIG_ENDIAN),
    ValueLayout.JAVA_INT.withOrder(ByteOrder.BIG_ENDIAN),
    ValueLayout.JAVA_INT.withOrder(ByteOrder.BIG_ENDIAN));

Implementation Requirements:: This class is immutable, thread-safe and value-based.
Since:: 19

Nested Class Summary
Method Summary
long

Returns the element count of this sequence layout.

Returns the element layout of this sequence layout.

Returns a flattened sequence layout.

Rearranges the elements in this sequence layout into a multi-dimensional sequence layout.

Returns a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes).

Returns a sequence layout with the same characteristics of this layout, but with the given element count.

Returns a memory layout with the same characteristics as this layout, but with the given name.
Methods declared in interface java.lang.foreign.MemoryLayout^PREVIEWbyteAlignment, byteOffset, byteOffsetHandle, byteSize, equals, hashCode, name, select, sliceHandle, toString, varHandle, withoutName

Method Details
- elementLayout
  Returns the element layout of this sequence layout.
  
  Returns:
  
  the element layout of this sequence layout
- elementCount
  long elementCount()
  
  Returns the element count of this sequence layout.
  
  Returns:
  
  the element count of this sequence layout
- withElementCount
  Returns a sequence layout with the same characteristics of this layout, but with the given element count.
  
  Parameters:
  
  elementCount - the new element count.
  
  Returns:
  
  a sequence layout with the same characteristics of this layout, but with the given element count
  
  Throws:
  
  IllegalArgumentException - if elementCount is negative.
  
  IllegalArgumentException - if elementLayout.bitSize() * elementCount overflows.
- reshape
  Rearranges the elements in this sequence layout into a multi-dimensional sequence layout. The resulting layout is a sequence layout where element layouts in the
  flattened projection
  of this sequence layout are rearranged into one or more nested sequence layouts according to the provided element counts. This transformation preserves the layout size; that is, multiplying the provided element counts must yield the same element count as the flattened projection of this sequence layout.
  
  For instance, given a sequence layout of the kind:
```
var seq = MemoryLayout.sequenceLayout(4, MemoryLayout.sequenceLayout(3, ValueLayout.JAVA_INT));
```
  calling
  seq.reshape(2, 6)
  will yield the following sequence layout:
```
var reshapeSeq = MemoryLayout.sequenceLayout(2, MemoryLayout.sequenceLayout(6, ValueLayout.JAVA_INT));
```
  If one of the provided element count is the special value -1, then the element count in that position will be inferred from the remaining element counts and the element count of the flattened projection of this layout. For instance, a layout equivalent to the above reshapeSeq can also be computed in the following ways:
```
var reshapeSeqImplicit1 = seq.reshape(-1, 6);
var reshapeSeqImplicit2 = seq.reshape(2, -1);
```
  Parameters:
  
  elementCounts - an array of element counts, of which at most one can be -1.
  
  Returns:
  
  a sequence layout where element layouts in the flattened projection of this sequence layout (see flatten()) are re-arranged into one or more nested sequence layouts.
  
  Throws:
  
  IllegalArgumentException - if two or more element counts are set to -1, or if one or more element count is <= 0 (but other than -1) or, if, after any required inference, multiplying the element counts does not yield the same element count as the flattened projection of this sequence layout.
- flatten
  Returns a flattened sequence layout. The element layout of the returned sequence layout is the first non-sequence layout found by inspecting (recursively, if needed) the element layout of this sequence layout:
```
MemoryLayout flatElementLayout(SequenceLayout sequenceLayout) {
   return switch (sequenceLayout.elementLayout()) {
       case SequenceLayout nestedSequenceLayout -> flatElementLayout(nestedSequenceLayout);
       case MemoryLayout layout -> layout;
   };
}
```
  This transformation preserves the layout size; nested sequence layout in this sequence layout will be dropped and their element counts will be incorporated into that of the returned sequence layout. For instance, given a sequence layout of the kind:
```
var seq = MemoryLayout.sequenceLayout(4, MemoryLayout.sequenceLayout(3, ValueLayout.JAVA_INT));
```
  calling
  seq.flatten()
  will yield the following sequence layout:
```
var flattenedSeq = MemoryLayout.sequenceLayout(12, ValueLayout.JAVA_INT);
```
  Returns:
  
  a sequence layout with the same size as this layout (but, possibly, with different element count), whose element layout is not a sequence layout.
- withName
  Returns a memory layout with the same characteristics as this layout, but with the given name.
  Specified by:
  
  withName in interface MemoryLayout^PREVIEW
  
  Parameters:
  
  name - the layout name.
  
  Returns:
  
  a memory layout with the same characteristics as this layout, but with the given name
  
  See Also:
  - MemoryLayout.name()^PREVIEW
- withByteAlignment
  Returns a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes).
  
  Specified by:
  
  withByteAlignment in interface MemoryLayout^PREVIEW
  
  Parameters:
  
  byteAlignment - the layout alignment constraint, expressed in bytes.
  
  Returns:
  
  a memory layout with the same characteristics as this layout, but with the given alignment constraint (in bytes)
  
  Throws:
  
  IllegalArgumentException - if byteAlignment is not a power of two.
  
  IllegalArgumentException - if byteAlignment < elementLayout().byteAlignment().

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4