OpenJDK 27 · jdk.incubator.vector.AbstractShuffle · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv static final IntUnaryOperator	IDENTITY

Access	Constructor and Description
pack-priv	AbstractShuffle(Object indices)

Method Summary

Modifier and Type	Method and Description
public final <F> VectorShuffle<F>	cast(VectorSpecies<F> s) Implements abstract jdk.incubator.vector.VectorShuffle.cast. Converts this shuffle to a shuffle of the given species of element type `F`.
public final <F> VectorShuffle<F>	check(VectorSpecies<F> species) Implements abstract jdk.incubator.vector.VectorShuffle.check. Checks that this shuffle has the given species, and returns this shuffle unchanged.
public final int	checkIndex(int index) Implements abstract jdk.incubator.vector.VectorShuffle.checkIndex. Validation function for lane indexes which may be out of the valid range of `[0..VLENGTH-1]`.
pack-priv static int	checkIndex0(int index, int laneCount, byte mode)
public final VectorShuffle<E>	checkIndexes() Implements abstract jdk.incubator.vector.VectorShuffle.checkIndexes. Apply the `checkIndex()` validation function to all lanes, throwing `IndexOutOfBoundsException` if there are any exceptional indexes in this shuffle.
private static IndexOutOfBoundsException	checkIndexFailed(int index, int laneCount)
pack-priv static int	partiallyWrapIndex(int index, int laneCount) Return invalid indexes partially wrapped mod VLENGTH to negative values.
public final int[]	toArray() Implements abstract jdk.incubator.vector.VectorShuffle.toArray. Returns an `int` array containing the lane source indexes of this shuffle.
pack-priv abstract AbstractVector<?>	toBitsVector()
pack-priv abstract AbstractVector<?>	toBitsVector0()
pack-priv final AbstractVector<?>	toBitsVectorTemplate()
public final VectorSpecies<E>	vectorSpecies() Implements abstract jdk.incubator.vector.VectorShuffle.vectorSpecies. Returns the species of this shuffle.
pack-priv abstract AbstractSpecies<E>	vspecies()
public final int	wrapIndex(int index) Implements abstract jdk.incubator.vector.VectorShuffle.wrapIndex. Validation function for lane indexes which may be out of the valid range of `[0..VLENGTH-1]`.

Inherited from jdk.incubator.vector.VectorShuffle:: equals fromArray fromMemorySegment fromOp fromValues hashCode intoArray intoMemorySegment iota laneIsValid laneSource length makeUnzip makeZip rearrange toString toVector wrapIndexes

IDENTITY	back to summary
pack-priv static final IntUnaryOperator IDENTITY

AbstractShuffle	back to summary
pack-priv AbstractShuffle(Object indices)

Method Detail

cast back to summary

cast	back to summary
public final <F> VectorShuffle<F> cast(VectorSpecies<F> s) Implements abstract jdk.incubator.vector.VectorShuffle.cast. Doc from jdk.incubator.vector.VectorShuffle.cast. Converts this shuffle to a shuffle of the given species of element type `F`. The various lane source indexes are unmodified. Exceptional source indexes remain exceptional and valid indexes remain valid. Annotations @Override @ForceInline

public final <F> VectorShuffle<F> cast(VectorSpecies<F> s)

Implements abstract jdk.incubator.vector.VectorShuffle.cast.

Doc from jdk.incubator.vector.VectorShuffle.cast.

Converts this shuffle to a shuffle of the given species of element type F. The various lane source indexes are unmodified. Exceptional source indexes remain exceptional and valid indexes remain valid.

Annotations

@Override
@ForceInline

check back to summary

check	back to summary
public final <F> VectorShuffle<F> check(VectorSpecies<F> species) Implements abstract jdk.incubator.vector.VectorShuffle.check. Doc from jdk.incubator.vector.VectorShuffle.check. Checks that this shuffle has the given species, and returns this shuffle unchanged. The effect is similar to this pseudocode: `species == vectorSpecies() ? this : throw new ClassCastException()`. Annotations @Override @ForceInline @SuppressWarnings:unchecked

public final <F> VectorShuffle<F> check(VectorSpecies<F> species)

Implements abstract jdk.incubator.vector.VectorShuffle.check.

Doc from jdk.incubator.vector.VectorShuffle.check.

Checks that this shuffle has the given species, and returns this shuffle unchanged. The effect is similar to this pseudocode: species == vectorSpecies() ? this : throw new ClassCastException().

Annotations

@Override
@ForceInline
@SuppressWarnings:unchecked

checkIndex back to summary

checkIndex	back to summary
public final int checkIndex(int index) Implements abstract jdk.incubator.vector.VectorShuffle.checkIndex. Doc from jdk.incubator.vector.VectorShuffle.checkIndex. Validation function for lane indexes which may be out of the valid range of `[0..VLENGTH-1]`. If `index` is in this range, it is returned unchanged. Otherwise, an `IndexOutOfBoundsException` is thrown. Annotations @Override @ForceInline

public final int checkIndex(int index)

Implements abstract jdk.incubator.vector.VectorShuffle.checkIndex.

Doc from jdk.incubator.vector.VectorShuffle.checkIndex.

Validation function for lane indexes which may be out of the valid range of [0..VLENGTH-1]. If index is in this range, it is returned unchanged. Otherwise, an IndexOutOfBoundsException is thrown.

Annotations

@Override
@ForceInline

checkIndex0	back to summary
pack-priv static int checkIndex0(int index, int laneCount, byte mode) Annotations @ForceInline

checkIndexes back to summary

checkIndexes	back to summary
public final VectorShuffle<E> checkIndexes() Implements abstract jdk.incubator.vector.VectorShuffle.checkIndexes. Doc from jdk.incubator.vector.VectorShuffle.checkIndexes. Apply the `checkIndex()` validation function to all lanes, throwing `IndexOutOfBoundsException` if there are any exceptional indexes in this shuffle. Annotations @Override @ForceInline

public final VectorShuffle<E> checkIndexes()

Implements abstract jdk.incubator.vector.VectorShuffle.checkIndexes.

Doc from jdk.incubator.vector.VectorShuffle.checkIndexes.

Apply the checkIndex() validation function to all lanes, throwing IndexOutOfBoundsException if there are any exceptional indexes in this shuffle.

Annotations

@Override
@ForceInline

checkIndexFailed	back to summary
private static IndexOutOfBoundsException checkIndexFailed(int index, int laneCount)

partiallyWrapIndex	back to summary
pack-priv static int partiallyWrapIndex(int index, int laneCount) Return invalid indexes partially wrapped mod VLENGTH to negative values. Annotations @ForceInline

partiallyWrapIndex

back to summary

pack-priv static int partiallyWrapIndex(int index, int laneCount)

Return invalid indexes partially wrapped mod VLENGTH to negative values.

Annotations

@ForceInline

toArray back to summary

toArray	back to summary
public final int[] toArray() Implements abstract jdk.incubator.vector.VectorShuffle.toArray. Doc from jdk.incubator.vector.VectorShuffle.toArray. Returns an `int` array containing the lane source indexes of this shuffle. This method behaves as if it stores this shuffle into an allocated array (using `intoArray`) and returns that array as follows: `int[] a = new int[this.length()]; VectorShuffle.intoArray(a, 0); return a;` Annotations @Override @ForceInline

public final int[] toArray()

Implements abstract jdk.incubator.vector.VectorShuffle.toArray.

Doc from jdk.incubator.vector.VectorShuffle.toArray.

Returns an int array containing the lane source indexes of this shuffle.

This method behaves as if it stores this shuffle into an allocated array (using intoArray) and returns that array as follows:

int[] a = new int[this.length()];
  VectorShuffle.intoArray(a, 0);
  return a;

Annotations

@Override
@ForceInline

toBitsVector	back to summary
pack-priv abstract AbstractVector<?> toBitsVector()

toBitsVector0	back to summary
pack-priv abstract AbstractVector<?> toBitsVector0()

toBitsVectorTemplate	back to summary
pack-priv final AbstractVector<?> toBitsVectorTemplate() Annotations @ForceInline

vectorSpecies	back to summary
public final VectorSpecies<E> vectorSpecies() Implements abstract jdk.incubator.vector.VectorShuffle.vectorSpecies. Doc from jdk.incubator.vector.VectorShuffle.vectorSpecies. Returns the species of this shuffle. Annotations @Override @ForceInline

vectorSpecies

back to summary

public final VectorSpecies<E> vectorSpecies()

Implements abstract jdk.incubator.vector.VectorShuffle.vectorSpecies.

Doc from jdk.incubator.vector.VectorShuffle.vectorSpecies.

Returns the species of this shuffle.

Annotations

@Override
@ForceInline

vspecies	back to summary
pack-priv abstract AbstractSpecies<E> vspecies()

wrapIndex back to summary

wrapIndex	back to summary
public final int wrapIndex(int index) Implements abstract jdk.incubator.vector.VectorShuffle.wrapIndex. Doc from jdk.incubator.vector.VectorShuffle.wrapIndex. Validation function for lane indexes which may be out of the valid range of `[0..VLENGTH-1]`. The `index` is forced into this range by adding or subtracting a suitable multiple of `VLENGTH`. Specifically, the index is reduced into the required range by computing the value of `length-floor`, where `floor=vectorSpecies().loopBound(length)` is the next lower multiple of `VLENGTH`. As long as `VLENGTH` is a power of two, then the reduced index also equal to `index & (VLENGTH - 1)`. Annotations @Override @ForceInline

public final int wrapIndex(int index)

Implements abstract jdk.incubator.vector.VectorShuffle.wrapIndex.

Doc from jdk.incubator.vector.VectorShuffle.wrapIndex.

Validation function for lane indexes which may be out of the valid range of [0..VLENGTH-1]. The index is forced into this range by adding or subtracting a suitable multiple of VLENGTH. Specifically, the index is reduced into the required range by computing the value of length-floor, where floor=vectorSpecies().loopBound(length) is the next lower multiple of VLENGTH. As long as VLENGTH is a power of two, then the reduced index also equal to index & (VLENGTH - 1).

Annotations

@Override
@ForceInline

pack-priv abstract sealed Class AbstractShuffle<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail