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

Modifier and Type	Class and Description
pack-priv static interface	AbstractSpecies.FOpm
pack-priv static interface	AbstractSpecies.RVOp

Modifier and Type	Field and Description
private static final AbstractSpecies<?>[][]	CACHES
pack-priv AbstractVector<E>	dummyVector
pack-priv final VectorShape	indexShape
pack-priv AbstractSpecies<Integer>	indexSpecies
pack-priv final int	laneCount
pack-priv final int	laneCountLog2P1
pack-priv final LaneType	laneType
pack-priv final Class<? extends AbstractMask<E>>	maskType
pack-priv final int	maxScale
pack-priv final int	minScale
pack-priv final Class<? extends AbstractShuffle<E>>	shuffleType
pack-priv AbstractShuffle<Byte>	swapBytesShuffle
pack-priv final int	vectorBitSize
pack-priv final int	vectorByteSize
pack-priv final Function<Object, ? extends AbstractVector<E>>	vectorFactory
pack-priv final VectorShape	vectorShape
pack-priv final Class<? extends AbstractVector<E>>	vectorType

Access	Constructor and Description
pack-priv	AbstractSpecies(VectorShape vectorShape, LaneType laneType, Class<? extends AbstractVector<E>> vectorType, Class<? extends AbstractMask<E>> maskType, Class<? extends AbstractShuffle<E>> shuffleType, Function<Object, ? extends AbstractVector<E>> vectorFactory)

Method Summary

Modifier and Type	Method and Description
pack-priv AbstractSpecies<?>	asFloating()
pack-priv AbstractSpecies<?>	asIntegral()
pack-priv static final IllegalArgumentException	badArrayBits(Object iv, boolean isInt, long cv)
pack-priv final IllegalArgumentException	badElementBits(long iv, Object cv)
pack-priv abstract AbstractVector<E>	broadcastBits(long bits)
pack-priv AbstractSpecies<Byte>	byteSpecies()
pack-priv Class<E>	carrierType()
public final <F> VectorSpecies<F>	check(Class<F> elementType) Implements jdk.incubator.vector.VectorSpecies.check. Checks that this species has the given element type, and returns this species unchanged.
pack-priv AbstractSpecies<E>	check(LaneType laneType)
pack-priv final <F> AbstractSpecies<F>	check0(Class<F> elementType)
pack-priv static ClassCastException	checkFailed(Object what, Object required) Helper for throwing CheckCastExceptions, used by the various Vector.check() methods.
pack-priv void	checkScale(int scale)
private IllegalArgumentException	checkScaleFailed(int scale)
private static AbstractSpecies<?>	computeSpecies(LaneType laneType, VectorShape shape)
pack-priv AbstractVector<E>	dummyVector() Do not use a dummy except to call methods on it when you don't care about the lane values.
pack-priv final int	elementByteSize()
public final int	elementSize() Implements jdk.incubator.vector.VectorSpecies.elementSize. Returns the lane size, in bits, of vectors of this species.
public Class<E>	elementType() Implements jdk.incubator.vector.VectorSpecies.elementType. Returns the primitive element type of vectors of this species.
public final boolean	equals(Object obj) Overrides java.lang.Object.equals. Implements jdk.incubator.vector.VectorSpecies.equals. Indicates whether this species is identical to some other object.
pack-priv static <E> AbstractSpecies<E>	findSpecies(Class<E> elementType, LaneType laneType, VectorShape shape)
pack-priv static AbstractSpecies<?>	findSpecies(LaneType laneType, VectorShape shape)
pack-priv abstract Vector<E>	fromIntValues(int[] values)
pack-priv Class<E>	genericElementType()
public final int	Returns: a hash code value for this shuffle hashCode() Overrides java.lang.Object.hashCode. Implements jdk.incubator.vector.VectorSpecies.hashCode. Returns a hash code value for the shuffle, based on the lane source indexes and the vector species.
public final VectorMask<E>	indexInRange(int offset, int limit) Implements jdk.incubator.vector.VectorSpecies.indexInRange. Returns a mask of this species where only the lanes at index N such that the adjusted index `N+offset` is in the range `[0..limit-1]` are set.
public final VectorMask<E>	indexInRange(long offset, long limit) Implements jdk.incubator.vector.VectorSpecies.indexInRange. Returns a mask of this species where only the lanes at index N such that the adjusted index `N+offset` is in the range `[0..limit-1]` are set.
pack-priv final VectorShape	indexShape()
pack-priv AbstractSpecies<Integer>	indexSpecies()
pack-priv abstract AbstractVector<E>	iota()
pack-priv Object	iotaArray()
public final VectorShuffle<E>	iotaShuffle(int start, int step, boolean wrap) Implements jdk.incubator.vector.VectorSpecies.iotaShuffle. Creates a shuffle using source indexes set to sequential values starting from `start` and stepping by the given `step`.
pack-priv final int	laneCount()
pack-priv final int	laneCountLog2()
pack-priv int	laneTypeOrdinal()
public final int	length() Implements jdk.incubator.vector.VectorSpecies.length. Returns the number of lanes in a vector of this species.
public VectorMask<E>	loadMask(boolean[] bits, int offset) Implements jdk.incubator.vector.VectorSpecies.loadMask. Returns a mask of this species where lane elements are initialized from the given array at the given offset.
pack-priv abstract long	longToElementBits(long e)
public final int	loopBound(int length) Implements jdk.incubator.vector.VectorSpecies.loopBound. Loop control function which returns the largest multiple of `VLENGTH` that is less than or equal to the given `length` value.
public final long	loopBound(long length) Implements jdk.incubator.vector.VectorSpecies.loopBound. Loop control function which returns the largest multiple of `VLENGTH` that is less than or equal to the given `length` value.
private AbstractVector<E>	makeDummyVector()
private AbstractShuffle<Byte>	makeSwapBytesShuffle()
pack-priv AbstractMask<E>	maskFactory(boolean[] bits) Build a mask by directly calling its constructor.
public final Class<? extends AbstractMask<E>>	maskType() Implements jdk.incubator.vector.VectorSpecies.maskType. Returns the vector mask type for this species.
pack-priv AbstractMask<E>	opm(AbstractSpecies.FOpm f)
public int	partLimit(VectorSpecies<?> toSpecies, boolean lanewise) Implements jdk.incubator.vector.VectorSpecies.partLimit. Given this species and a second one, reports the net expansion or contraction of a (potentially) resizing reinterpretation cast or `lane-wise conversion` from this species to the second.
pack-priv abstract AbstractVector<E>	rvOp(AbstractSpecies.RVOp f)
public final VectorShuffle<E>	shuffleFromArray(int[] sourceIndexes, int offset) Implements jdk.incubator.vector.VectorSpecies.shuffleFromArray. Creates a shuffle for this species from an `int` array starting at an offset.
public final VectorShuffle<E>	shuffleFromOp(IntUnaryOperator fn) Implements jdk.incubator.vector.VectorSpecies.shuffleFromOp. Creates a shuffle for this species from the successive values of an operator applied to the range `[0..VLENGTH-1]`.
public final VectorShuffle<E>	shuffleFromValues(int... sourceIndexes) Implements jdk.incubator.vector.VectorSpecies.shuffleFromValues. Creates a shuffle for this species from a series of source indexes.
pack-priv final Class<? extends AbstractShuffle<E>>	shuffleType()
pack-priv AbstractShuffle<Byte>	swapBytesShuffle()
public final String	toString() Overrides java.lang.Object.toString. Implements jdk.incubator.vector.VectorSpecies.toString. Returns a string of the form "Species[ETYPE, VLENGTH, SHAPE]", where `ETYPE` is the primitive lane type, `VLENGTH` is the vector lane count associated with the species, and `SHAPE` is the vector shape associated with the species.
public final int	vectorBitSize() Implements jdk.incubator.vector.VectorSpecies.vectorBitSize. Returns the total vector size, in bits, of any vector of this species.
public final int	vectorByteSize() Implements jdk.incubator.vector.VectorSpecies.vectorByteSize. Returns the total vector size, in bytes, of any vector of this species.
public final VectorShape	vectorShape() Implements jdk.incubator.vector.VectorSpecies.vectorShape. Returns the shape of vectors produced by this species.
public Class<? extends AbstractVector<E>>	vectorType() Implements jdk.incubator.vector.VectorSpecies.vectorType. Returns the vector type of this species.
public final <F> VectorSpecies<F>	withLanes(Class<F> newType) Implements jdk.incubator.vector.VectorSpecies.withLanes. Finds a species with the given element type and the same shape as this species.
pack-priv final AbstractSpecies<?>	withLanes(LaneType newType)
public final VectorSpecies<E>	withShape(VectorShape newShape) Implements jdk.incubator.vector.VectorSpecies.withShape. Finds a species with the given shape and the same elementType as this species.
public abstract AbstractVector<E>	zero() Redeclares jdk.incubator.vector.VectorSpecies.zero. Returns a vector of this species where all lane elements are set to the default primitive value, `(ETYPE)0`.

CACHES	back to summary
private static final AbstractSpecies<?>[][] CACHES Annotations @Stable

dummyVector	back to summary
pack-priv AbstractVector<E> dummyVector Annotations @Stable

indexShape	back to summary
pack-priv final VectorShape indexShape

indexSpecies	back to summary
pack-priv AbstractSpecies<Integer> indexSpecies Annotations @Stable

laneCount	back to summary
pack-priv final int laneCount

laneCountLog2P1	back to summary
pack-priv final int laneCountLog2P1

laneType	back to summary
pack-priv final LaneType laneType

maskType	back to summary
pack-priv final Class<? extends AbstractMask<E>> maskType

maxScale	back to summary
pack-priv final int maxScale

minScale	back to summary
pack-priv final int minScale

shuffleType	back to summary
pack-priv final Class<? extends AbstractShuffle<E>> shuffleType

swapBytesShuffle	back to summary
pack-priv AbstractShuffle<Byte> swapBytesShuffle Annotations @Stable

vectorBitSize	back to summary
pack-priv final int vectorBitSize

vectorByteSize	back to summary
pack-priv final int vectorByteSize

vectorFactory	back to summary
pack-priv final Function<Object, ? extends AbstractVector<E>> vectorFactory

vectorShape	back to summary
pack-priv final VectorShape vectorShape

vectorType	back to summary
pack-priv final Class<? extends AbstractVector<E>> vectorType

AbstractSpecies	back to summary
pack-priv AbstractSpecies(VectorShape vectorShape, LaneType laneType, Class<? extends AbstractVector<E>> vectorType, Class<? extends AbstractMask<E>> maskType, Class<? extends AbstractShuffle<E>> shuffleType, Function<Object, ? extends AbstractVector<E>> vectorFactory)

Method Detail

asFloating	back to summary
pack-priv AbstractSpecies<?> asFloating() Annotations @ForceInline

asIntegral	back to summary
pack-priv AbstractSpecies<?> asIntegral() Annotations @ForceInline

badArrayBits	back to summary
pack-priv static final IllegalArgumentException badArrayBits(Object iv, boolean isInt, long cv)

badElementBits	back to summary
pack-priv final IllegalArgumentException badElementBits(long iv, Object cv)

broadcastBits	back to summary
pack-priv abstract AbstractVector<E> broadcastBits(long bits)

byteSpecies	back to summary
pack-priv AbstractSpecies<Byte> byteSpecies() Annotations @ForceInline @SuppressWarnings:unchecked

carrierType	back to summary
pack-priv Class<E> carrierType() Annotations @ForceInline @SuppressWarnings:unchecked

check back to summary

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

public final <F> VectorSpecies<F> check(Class<F> elementType)

Implements jdk.incubator.vector.VectorSpecies.check.

Doc from jdk.incubator.vector.VectorSpecies.check.

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

Annotations

@Override
@ForceInline

check	back to summary
pack-priv AbstractSpecies<E> check(LaneType laneType) Annotations @ForceInline

check0	back to summary
pack-priv final <F> AbstractSpecies<F> check0(Class<F> elementType) Annotations @ForceInline @SuppressWarnings:unchecked

checkFailed	back to summary
pack-priv static ClassCastException checkFailed(Object what, Object required) Helper for throwing CheckCastExceptions, used by the various Vector.check() methods.

checkScale	back to summary
pack-priv void checkScale(int scale) Annotations @ForceInline

checkScaleFailed	back to summary
private IllegalArgumentException checkScaleFailed(int scale)

computeSpecies	back to summary
private static AbstractSpecies<?> computeSpecies(LaneType laneType, VectorShape shape)

dummyVector	back to summary
pack-priv AbstractVector<E> dummyVector() Do not use a dummy except to call methods on it when you don't care about the lane values. The main benefit of it is to populate the type profile, which then allows the JIT to derive constant values for dummy.species(), the current species, and then for all of its attributes: ETYPE, VLENGTH, VSHAPE, etc. Annotations @ForceInline

dummyVector

back to summary

pack-priv AbstractVector<E> dummyVector()

Do not use a dummy except to call methods on it when you don't care about the lane values. The main benefit of it is to populate the type profile, which then allows the JIT to derive constant values for dummy.species(), the current species, and then for all of its attributes: ETYPE, VLENGTH, VSHAPE, etc.

Annotations

@ForceInline

elementByteSize	back to summary
pack-priv final int elementByteSize() Annotations @ForceInline

elementSize	back to summary
public final int elementSize() Implements jdk.incubator.vector.VectorSpecies.elementSize. Doc from jdk.incubator.vector.VectorSpecies.elementSize. Returns the lane size, in bits, of vectors of this species. Annotations @Override @ForceInline

elementSize

back to summary

public final int elementSize()

Implements jdk.incubator.vector.VectorSpecies.elementSize.

Doc from jdk.incubator.vector.VectorSpecies.elementSize.

Returns the lane size, in bits, of vectors of this species.

Annotations

@Override
@ForceInline

elementType	back to summary
public Class<E> elementType() Implements jdk.incubator.vector.VectorSpecies.elementType. Doc from jdk.incubator.vector.VectorSpecies.elementType. Returns the primitive element type of vectors of this species. Annotations @Override @ForceInline @SuppressWarnings:unchecked

elementType

back to summary

public Class<E> elementType()

Implements jdk.incubator.vector.VectorSpecies.elementType.

Doc from jdk.incubator.vector.VectorSpecies.elementType.

Returns the primitive element type of vectors of this species.

Annotations

@Override
@ForceInline
@SuppressWarnings:unchecked

equals	back to summary
public final boolean equals(Object obj) Overrides java.lang.Object.equals. Implements jdk.incubator.vector.VectorSpecies.equals. Doc from jdk.incubator.vector.VectorSpecies.equals. Indicates whether this species is identical to some other object. Two species are identical only if they have the same shape and same element type. Annotations @Override

equals

back to summary

public final boolean equals(Object obj)

Overrides java.lang.Object.equals.

Implements jdk.incubator.vector.VectorSpecies.equals.

Doc from jdk.incubator.vector.VectorSpecies.equals.

Indicates whether this species is identical to some other object. Two species are identical only if they have the same shape and same element type.

Annotations

@Override

findSpecies	back to summary
pack-priv static <E> AbstractSpecies<E> findSpecies(Class<E> elementType, LaneType laneType, VectorShape shape) Annotations @ForceInline

findSpecies	back to summary
pack-priv static AbstractSpecies<?> findSpecies(LaneType laneType, VectorShape shape) Annotations @ForceInline

fromIntValues	back to summary
pack-priv abstract Vector<E> fromIntValues(int[] values)

genericElementType	back to summary
pack-priv Class<E> genericElementType() Annotations @ForceInline @SuppressWarnings:unchecked

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Implements jdk.incubator.vector.VectorSpecies.hashCode. Returns a hash code value for the shuffle, based on the lane source indexes and the vector species. Returns:int a hash code value for this shuffle Annotations @Override

hashCode

back to summary

public final int hashCode()

Overrides java.lang.Object.hashCode.

Implements jdk.incubator.vector.VectorSpecies.hashCode.

Returns a hash code value for the shuffle, based on the lane source indexes and the vector species.

Returns:int

a hash code value for this shuffle

Annotations

@Override

indexInRange back to summary

indexInRange	back to summary
public final VectorMask<E> indexInRange(int offset, int limit) Implements jdk.incubator.vector.VectorSpecies.indexInRange. Doc from jdk.incubator.vector.VectorSpecies.indexInRange. Returns a mask of this species where only the lanes at index N such that the adjusted index `N+offset` is in the range `[0..limit-1]` are set. This method returns the value of the expression `maskAll(true).indexInRange(offset, limit)` Annotations @Override @ForceInline

public final VectorMask<E> indexInRange(int offset, int limit)

Implements jdk.incubator.vector.VectorSpecies.indexInRange.

Doc from jdk.incubator.vector.VectorSpecies.indexInRange.

Returns a mask of this species where only the lanes at index N such that the adjusted index N+offset is in the range [0..limit-1] are set.

This method returns the value of the expression maskAll(true).indexInRange(offset, limit)

Annotations

@Override
@ForceInline

indexInRange back to summary

indexInRange	back to summary
public final VectorMask<E> indexInRange(long offset, long limit) Implements jdk.incubator.vector.VectorSpecies.indexInRange. Doc from jdk.incubator.vector.VectorSpecies.indexInRange. Returns a mask of this species where only the lanes at index N such that the adjusted index `N+offset` is in the range `[0..limit-1]` are set. This method returns the value of the expression `maskAll(true).indexInRange(offset, limit)` Annotations @Override @ForceInline

public final VectorMask<E> indexInRange(long offset, long limit)

Implements jdk.incubator.vector.VectorSpecies.indexInRange.

Doc from jdk.incubator.vector.VectorSpecies.indexInRange.

Returns a mask of this species where only the lanes at index N such that the adjusted index N+offset is in the range [0..limit-1] are set.

This method returns the value of the expression maskAll(true).indexInRange(offset, limit)

Annotations

@Override
@ForceInline

indexShape	back to summary
pack-priv final VectorShape indexShape() Annotations @ForceInline

indexSpecies	back to summary
pack-priv AbstractSpecies<Integer> indexSpecies() Annotations @ForceInline

iota	back to summary
pack-priv abstract AbstractVector<E> iota()

iotaArray	back to summary
pack-priv Object iotaArray()

iotaShuffle back to summary

public final VectorShuffle<E> iotaShuffle(int start, int step, boolean wrap)

Implements jdk.incubator.vector.VectorSpecies.iotaShuffle.

Doc from jdk.incubator.vector.VectorSpecies.iotaShuffle.

Creates a shuffle using source indexes set to sequential values starting from start and stepping by the given step.

This method returns the value of the expression VectorSpecies.shuffleFromOp(i -> R(start + i * step)), where R is wrapIndex if wrap is true, and is the identity function otherwise.

If wrap is false each index is validated against the species VLENGTH, and (if invalid) is partially wrapped to an exceptional index in the range [-VLENGTH..-1]. Otherwise, if wrap is true, also reduce each index, as if by wrapIndex, to the valid range [0..VLENGTH-1].

Annotations

@Override
@ForceInline

laneCount	back to summary
pack-priv final int laneCount() Annotations @ForceInline

laneCountLog2	back to summary
pack-priv final int laneCountLog2() Annotations @ForceInline

laneTypeOrdinal	back to summary
pack-priv int laneTypeOrdinal() Annotations @ForceInline @SuppressWarnings:unchecked

length

back to summary

public final int length()

Implements jdk.incubator.vector.VectorSpecies.length.

Doc from jdk.incubator.vector.VectorSpecies.length.

Returns the number of lanes in a vector of this species.

Annotations

@Override
@ForceInline

loadMask back to summary

public VectorMask<E> loadMask(boolean[] bits, int offset)

Implements jdk.incubator.vector.VectorSpecies.loadMask.

Doc from jdk.incubator.vector.VectorSpecies.loadMask.

Returns a mask of this species where lane elements are initialized from the given array at the given offset. Equivalent to VectorMask.fromArray(this,a,offset).

Annotations

@Override

longToElementBits	back to summary
pack-priv abstract long longToElementBits(long e)

loopBound back to summary

public final int loopBound(int length)

Implements jdk.incubator.vector.VectorSpecies.loopBound.

Doc from jdk.incubator.vector.VectorSpecies.loopBound.

Loop control function which returns the largest multiple of VLENGTH that is less than or equal to the given length value. Here, VLENGTH is the result of this.length(), and length is interpreted as a number of lanes. The resulting value R satisfies this inequality:

R <= length < R+VLENGTH

Specifically, this method computes length - floorMod(length, VLENGTH), where floorMod computes a remainder value by rounding its quotient toward negative infinity. As long as VLENGTH is a power of two, then the result is also equal to length & ~(VLENGTH - 1).

Annotations

@Override
@ForceInline

loopBound back to summary

public final long loopBound(long length)

Implements jdk.incubator.vector.VectorSpecies.loopBound.

Doc from jdk.incubator.vector.VectorSpecies.loopBound.

R <= length < R+VLENGTH

Annotations

@Override
@ForceInline

makeDummyVector	back to summary
private AbstractVector<E> makeDummyVector()

makeSwapBytesShuffle	back to summary
private AbstractShuffle<Byte> makeSwapBytesShuffle()

maskFactory

back to summary

pack-priv AbstractMask<E> maskFactory(boolean[] bits)

Build a mask by directly calling its constructor. It is an error if the array is aliased elsewhere.

Annotations

@ForceInline

maskType

back to summary

public final Class<? extends AbstractMask<E>> maskType()

Implements jdk.incubator.vector.VectorSpecies.maskType.

Doc from jdk.incubator.vector.VectorSpecies.maskType.

Returns the vector mask type for this species.

Annotations

@Override
@ForceInline

opm	back to summary
pack-priv AbstractMask<E> opm(AbstractSpecies.FOpm f)

partLimit back to summary

public int partLimit(VectorSpecies<?> toSpecies, boolean lanewise)

Implements jdk.incubator.vector.VectorSpecies.partLimit.

Doc from jdk.incubator.vector.VectorSpecies.partLimit.

Given this species and a second one, reports the net expansion or contraction of a (potentially) resizing reinterpretation cast or lane-wise conversion from this species to the second. The sign and magnitude of the return value depends on the size difference between the proposed input and output shapes, and (optionally, if lanewise is true) also on the size difference between the proposed input and output lanes.

First, a logical result size is determined. If lanewise is false, this size that of the input VSHAPE. If lanewise is true, the logical result size is the product of the input VLENGTH times the size of the output ETYPE.
Next, the logical result size is compared against the size of the proposed output shape, to see how it will fit.
If the logical result fits precisely in the output shape, the return value is zero, signifying no net expansion or contraction.
If the logical result would overflow the output shape, the return value is the ratio (greater than one) of the logical result size to the (smaller) output size. This ratio can be viewed as measuring the proportion of "dropped input bits" which must be deleted from the input in order for the result to fit in the output vector. It is also the part limit, an upper exclusive limit on the part parameter to a method that would transform the input species to the output species.
If the logical result would drop into the output shape with room to spare, the return value is a negative number whose absolute value the ratio (greater than one) between the output size and the (smaller) logical result size. This ratio can be viewed as measuring the proportion of "extra padding bits" which must be added to the logical result to fill up the output vector. It is also the part limit, an exclusive lower limit on the part parameter to a method that would transform the input species to the output species.

Annotations

@Override
@ForceInline

rvOp	back to summary
pack-priv abstract AbstractVector<E> rvOp(AbstractSpecies.RVOp f)

shuffleFromArray back to summary

public final VectorShuffle<E> shuffleFromArray(int[] sourceIndexes, int offset)

Implements jdk.incubator.vector.VectorSpecies.shuffleFromArray.

Doc from jdk.incubator.vector.VectorSpecies.shuffleFromArray.

Creates a shuffle for this species from an int array starting at an offset.

For each shuffle lane, where N is the shuffle lane index, the array element at index i + N is validated against the species VLENGTH, and (if invalid) is partially wrapped to an exceptional index in the range [-VLENGTH..-1].

Annotations

@Override
@ForceInline

shuffleFromOp back to summary

public final VectorShuffle<E> shuffleFromOp(IntUnaryOperator fn)

Implements jdk.incubator.vector.VectorSpecies.shuffleFromOp.

Doc from jdk.incubator.vector.VectorSpecies.shuffleFromOp.

Creates a shuffle for this species from the successive values of an operator applied to the range [0..VLENGTH-1].

For each shuffle lane, where N is the shuffle lane index, the Nth index value is validated against the species VLENGTH, and (if invalid) is partially wrapped to an exceptional index in the range [-VLENGTH..-1].

Care should be taken to ensure VectorShuffle values produced from this method are consumed as constants to ensure optimal generation of code. For example, shuffle values can be held in static final fields or loop-invariant local variables.

This method behaves as if a shuffle is created from an array of mapped indexes as follows:

int[] a = new int[VLENGTH];
  for (int i = 0; i < a.length; i++) {
      a[i] = fn.applyAsInt(i);
  }
  return VectorShuffle.fromArray(this, a, 0);

Annotations

@Override
@ForceInline

shuffleFromValues back to summary

public final VectorShuffle<E> shuffleFromValues(int... sourceIndexes)

Implements jdk.incubator.vector.VectorSpecies.shuffleFromValues.

Doc from jdk.incubator.vector.VectorSpecies.shuffleFromValues.

Creates a shuffle for this species from a series of source indexes.

Annotations

@Override
@ForceInline

shuffleType	back to summary
pack-priv final Class<? extends AbstractShuffle<E>> shuffleType() Annotations @ForceInline

swapBytesShuffle	back to summary
pack-priv AbstractShuffle<Byte> swapBytesShuffle() Annotations @ForceInline

toString back to summary

public final String toString()

Overrides java.lang.Object.toString.

Implements jdk.incubator.vector.VectorSpecies.toString.

Doc from jdk.incubator.vector.VectorSpecies.toString.

Returns a string of the form "Species[ETYPE, VLENGTH, SHAPE]", where ETYPE is the primitive lane type, VLENGTH is the vector lane count associated with the species, and SHAPE is the vector shape associated with the species.

Annotations

@Override

vectorBitSize back to summary

public final int vectorBitSize()

Implements jdk.incubator.vector.VectorSpecies.vectorBitSize.

Doc from jdk.incubator.vector.VectorSpecies.vectorBitSize.

Returns the total vector size, in bits, of any vector of this species. This is the same value as this.vectorShape().vectorBitSize().

Annotations

@Override
@ForceInline

vectorByteSize back to summary

public final int vectorByteSize()

Implements jdk.incubator.vector.VectorSpecies.vectorByteSize.

Doc from jdk.incubator.vector.VectorSpecies.vectorByteSize.

Returns the total vector size, in bytes, of any vector of this species. This is the same value as this.vectorShape().vectorBitSize() / Byte.SIZE.

Annotations

@Override
@ForceInline

vectorShape

back to summary

public final VectorShape vectorShape()

Implements jdk.incubator.vector.VectorSpecies.vectorShape.

Doc from jdk.incubator.vector.VectorSpecies.vectorShape.

Returns the shape of vectors produced by this species.

Annotations

@Override
@ForceInline

vectorType

back to summary

public Class<? extends AbstractVector<E>> vectorType()

Implements jdk.incubator.vector.VectorSpecies.vectorType.

Doc from jdk.incubator.vector.VectorSpecies.vectorType.

Returns the vector type of this species. A vector is of this species if and only if it is of the corresponding vector type.

Annotations

@Override
@ForceInline

withLanes back to summary

public final <F> VectorSpecies<F> withLanes(Class<F> newType)

Implements jdk.incubator.vector.VectorSpecies.withLanes.

Doc from jdk.incubator.vector.VectorSpecies.withLanes.

Finds a species with the given element type and the same shape as this species. Returns the same value as VectorSpecies.of(newType, this.vectorShape()).

Annotations

@Override
@ForceInline

withLanes	back to summary
pack-priv final AbstractSpecies<?> withLanes(LaneType newType) Annotations @ForceInline

withShape back to summary

public final VectorSpecies<E> withShape(VectorShape newShape)

Implements jdk.incubator.vector.VectorSpecies.withShape.

Doc from jdk.incubator.vector.VectorSpecies.withShape.

Finds a species with the given shape and the same elementType as this species. Returns the same value as VectorSpecies.of(this.elementType(), newShape).

Annotations

@Override
@ForceInline
@SuppressWarnings:unchecked

zero back to summary

public abstract AbstractVector<E> zero()

Redeclares jdk.incubator.vector.VectorSpecies.zero.

Doc from jdk.incubator.vector.VectorSpecies.zero.

Returns a vector of this species where all lane elements are set to the default primitive value, (ETYPE)0. Equivalent to IntVector.zero(this) or an equivalent zero method, on the vector type corresponding to this species.

pack-priv abstract sealed Class AbstractSpecies<E>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface AbstractSpecies.FOpm

Method Summary

Method Detail

pack-priv Interface AbstractSpecies.RVOp

Method Summary

Method Detail