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

Modifier and Type	Class and Description
pack-priv static interface	AbstractMask.MBinOp
pack-priv static interface	AbstractMask.MUnOp

Access	Constructor and Description
pack-priv	AbstractMask(boolean[] bits)

Method Summary

Modifier and Type	Method and Description
pack-priv static boolean	allTrueHelper(boolean[] bits)
public final VectorMask<E>	andNot(VectorMask<E> m) Implements abstract jdk.incubator.vector.VectorMask.andNot. Logically subtracts a second input mask from this mask (as `a&~b`).
pack-priv static boolean	anyTrueHelper(boolean[] bits)
pack-priv abstract AbstractMask<E>	bOp(VectorMask<E> o, AbstractMask.MBinOp f)
public <F> VectorMask<F>	check(Class<F> elementType) Implements abstract jdk.incubator.vector.VectorMask.check. Checks that this mask applies to vectors with the given element type, and returns this mask unchanged.
public <F> VectorMask<F>	check(VectorSpecies<F> species) Implements abstract jdk.incubator.vector.VectorMask.check. Checks that this mask has the given species, and returns this mask unchanged.
pack-priv <F> VectorMask<F>	check(Class<? extends VectorMask<F>> maskClass, Vector<F> vector) Implements abstract jdk.incubator.vector.VectorMask.check. Checks that this mask has the same class with the given mask class, and it has the same species with given vector's species, and returns this mask unchanged.
private VectorMask<E>	checkIndex0(int offset, int length, Vector<E> iota, int vlength)
private VectorMask<E>	checkIndex0(long offset, long length, Vector<E> iota, int vlength)
pack-priv void	checkIndexByLane(int offset, int length, Vector<E> iota, int esize) Test if a masked memory access at a given offset into an array of the given length will stay within the array.
pack-priv void	checkIndexByLane(long offset, long length, Vector<E> iota, int esize) Test if a masked memory access at a given offset into an array of the given length will stay within the array.
private IndexOutOfBoundsException	checkIndexFailed(long offset, int lane, long length, int esize)
public final VectorMask<E>	eq(VectorMask<E> m) Implements abstract jdk.incubator.vector.VectorMask.eq. Determines logical equivalence of this mask to a second input mask (as boolean `a==b` or `a^~b`).
pack-priv static int	firstTrueHelper(boolean[] bits)
pack-priv abstract boolean[]	getBits()
public VectorMask<E>	indexInRange(int offset, int limit) Implements abstract jdk.incubator.vector.VectorMask.indexInRange. Removes lanes numbered `N` from this mask where the adjusted index `N+offset`, is not in the range `[0..limit-1]`.
public VectorMask<E>	indexInRange(long offset, long limit) Implements abstract jdk.incubator.vector.VectorMask.indexInRange. Removes lanes numbered `N` from this mask where the adjusted index `N+offset`, is not in the range `[0..limit-1]`.
pack-priv VectorMask<E>	indexPartiallyInRange(int offset, int limit)
pack-priv VectorMask<E>	indexPartiallyInRange(long offset, long limit)
pack-priv abstract VectorMask<E>	indexPartiallyInUpperRange(long offset, long limit)
public void	intoArray(boolean[] bits, int i) Implements abstract jdk.incubator.vector.VectorMask.intoArray. Stores this mask into a `boolean` array starting at offset.
pack-priv static int	lastTrueHelper(boolean[] bits)
private <F> boolean	sameSpecies(Class<? extends VectorMask<F>> maskClass, Vector<F> vector)
public boolean[]	toArray() Implements abstract jdk.incubator.vector.VectorMask.toArray. Returns an `boolean` array containing the lane elements of this mask.
pack-priv static long	toLongHelper(boolean[] bits)
pack-priv AbstractVector<E>	toVectorTemplate()
pack-priv static int	trueCountHelper(boolean[] bits)
pack-priv abstract AbstractMask<E>	uOp(AbstractMask.MUnOp f)
public final VectorSpecies<E>	vectorSpecies() Implements abstract jdk.incubator.vector.VectorMask.vectorSpecies. Returns the vector species to which this mask applies.
pack-priv abstract AbstractSpecies<E>	vspecies()

Inherited from jdk.incubator.vector.VectorMask:: allTrue and anyTrue cast compress equals firstTrue fromArray fromLong fromValues hashCode laneIsSet lastTrue length not or toLong toString toVector trueCount xor

AbstractMask	back to summary
pack-priv AbstractMask(boolean[] bits)

Method Detail

allTrueHelper	back to summary
pack-priv static boolean allTrueHelper(boolean[] bits)

andNot back to summary

andNot	back to summary
public final VectorMask<E> andNot(VectorMask<E> m) Implements abstract jdk.incubator.vector.VectorMask.andNot. Doc from jdk.incubator.vector.VectorMask.andNot. Logically subtracts a second input mask from this mask (as `a&~b`). This is a lane-wise binary operation which applies the logical `ANDC` operation (`&~`) to each corresponding pair of mask bits. Annotations @Override @ForceInline

public final VectorMask<E> andNot(VectorMask<E> m)

Implements abstract jdk.incubator.vector.VectorMask.andNot.

Doc from jdk.incubator.vector.VectorMask.andNot.

Logically subtracts a second input mask from this mask (as a&~b).

This is a lane-wise binary operation which applies the logical ANDC operation (&~) to each corresponding pair of mask bits.

Annotations

@Override
@ForceInline

anyTrueHelper	back to summary
pack-priv static boolean anyTrueHelper(boolean[] bits)

bOp	back to summary
pack-priv abstract AbstractMask<E> bOp(VectorMask<E> o, AbstractMask.MBinOp f)

check back to summary

check	back to summary
public <F> VectorMask<F> check(Class<F> elementType) Implements abstract jdk.incubator.vector.VectorMask.check. Doc from jdk.incubator.vector.VectorMask.check. Checks that this mask applies to vectors with the given element type, and returns this mask unchanged. The effect is similar to this pseudocode: `elementType == vectorSpecies().elementType() ? this : throw new ClassCastException()`. Annotations @Override @ForceInline @SuppressWarnings:unchecked

public <F> VectorMask<F> check(Class<F> elementType)

Implements abstract jdk.incubator.vector.VectorMask.check.

Doc from jdk.incubator.vector.VectorMask.check.

Checks that this mask applies to vectors with the given element type, and returns this mask unchanged. The effect is similar to this pseudocode: elementType == vectorSpecies().elementType() ? this : throw new ClassCastException().

Annotations

@Override
@ForceInline
@SuppressWarnings:unchecked

check back to summary

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

public <F> VectorMask<F> check(VectorSpecies<F> species)

Implements abstract jdk.incubator.vector.VectorMask.check.

Doc from jdk.incubator.vector.VectorMask.check.

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

Annotations

@Override
@ForceInline
@SuppressWarnings:unchecked

check back to summary

check	back to summary
pack-priv <F> VectorMask<F> check(Class<? extends VectorMask<F>> maskClass, Vector<F> vector) Implements abstract jdk.incubator.vector.VectorMask.check. Doc from jdk.incubator.vector.VectorMask.check. Checks that this mask has the same class with the given mask class, and it has the same species with given vector's species, and returns this mask unchanged. The effect is similar to this pseudocode: `getClass() == maskClass && vectorSpecies() == vector.species() ? this : throw new ClassCastException()`. Annotations @Override @ForceInline @SuppressWarnings:unchecked

pack-priv <F> VectorMask<F> check(Class<? extends VectorMask<F>> maskClass, Vector<F> vector)

Implements abstract jdk.incubator.vector.VectorMask.check.

Doc from jdk.incubator.vector.VectorMask.check.

Checks that this mask has the same class with the given mask class, and it has the same species with given vector's species, and returns this mask unchanged. The effect is similar to this pseudocode: getClass() == maskClass && vectorSpecies() == vector.species() ? this : throw new ClassCastException().

Annotations

@Override
@ForceInline
@SuppressWarnings:unchecked

checkIndex0	back to summary
private VectorMask<E> checkIndex0(int offset, int length, Vector<E> iota, int vlength) Annotations @ForceInline

checkIndex0	back to summary
private VectorMask<E> checkIndex0(long offset, long length, Vector<E> iota, int vlength) Annotations @ForceInline

checkIndexByLane	back to summary
pack-priv void checkIndexByLane(int offset, int length, Vector<E> iota, int esize) Test if a masked memory access at a given offset into an array of the given length will stay within the array. The per-lane offsets are iota*esize. Annotations @ForceInline

checkIndexByLane

back to summary

pack-priv void checkIndexByLane(int offset, int length, Vector<E> iota, int esize)

Test if a masked memory access at a given offset into an array of the given length will stay within the array. The per-lane offsets are iota*esize.

Annotations

@ForceInline

checkIndexByLane	back to summary
pack-priv void checkIndexByLane(long offset, long length, Vector<E> iota, int esize) Test if a masked memory access at a given offset into an array of the given length will stay within the array. The per-lane offsets are iota*esize. Annotations @ForceInline

checkIndexByLane

back to summary

pack-priv void checkIndexByLane(long offset, long length, Vector<E> iota, int esize)

Test if a masked memory access at a given offset into an array of the given length will stay within the array. The per-lane offsets are iota*esize.

Annotations

@ForceInline

checkIndexFailed	back to summary
private IndexOutOfBoundsException checkIndexFailed(long offset, int lane, long length, int esize)

eq back to summary

eq	back to summary
public final VectorMask<E> eq(VectorMask<E> m) Implements abstract jdk.incubator.vector.VectorMask.eq. Doc from jdk.incubator.vector.VectorMask.eq. Determines logical equivalence of this mask to a second input mask (as boolean `a==b` or `a^~b`). This is a lane-wise binary operation tests each corresponding pair of mask bits for equality. It is also equivalent to the logical `XNOR` operation (`^~`) to each corresponding pair of mask bits. Annotations @Override @ForceInline

public final VectorMask<E> eq(VectorMask<E> m)

Implements abstract jdk.incubator.vector.VectorMask.eq.

Doc from jdk.incubator.vector.VectorMask.eq.

Determines logical equivalence of this mask to a second input mask (as boolean a==b or a^~b).

This is a lane-wise binary operation tests each corresponding pair of mask bits for equality. It is also equivalent to the logical XNOR operation (^~) to each corresponding pair of mask bits.

Annotations

@Override
@ForceInline

firstTrueHelper	back to summary
pack-priv static int firstTrueHelper(boolean[] bits)

getBits	back to summary
pack-priv abstract boolean[] getBits()

indexInRange back to summary

indexInRange	back to summary
public VectorMask<E> indexInRange(int offset, int limit) Implements abstract jdk.incubator.vector.VectorMask.indexInRange. Doc from jdk.incubator.vector.VectorMask.indexInRange. Removes lanes numbered `N` from this mask where the adjusted index `N+offset`, is not in the range `[0..limit-1]`. In all cases the series of set and unset lanes is assigned as if by using infinite precision or `VLENGTH-`saturating additions or subtractions, without overflow or wrap-around. Annotations @Override @ForceInline

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

Implements abstract jdk.incubator.vector.VectorMask.indexInRange.

Doc from jdk.incubator.vector.VectorMask.indexInRange.

Removes lanes numbered N from this mask where the adjusted index N+offset, is not in the range [0..limit-1].

In all cases the series of set and unset lanes is assigned as if by using infinite precision or VLENGTH-saturating additions or subtractions, without overflow or wrap-around.

Annotations

@Override
@ForceInline

indexInRange back to summary

indexInRange	back to summary
public VectorMask<E> indexInRange(long offset, long limit) Implements abstract jdk.incubator.vector.VectorMask.indexInRange. Doc from jdk.incubator.vector.VectorMask.indexInRange. Removes lanes numbered `N` from this mask where the adjusted index `N+offset`, is not in the range `[0..limit-1]`. In all cases the series of set and unset lanes is assigned as if by using infinite precision or `VLENGTH-`saturating additions or subtractions, without overflow or wrap-around. Annotations @ForceInline

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

Implements abstract jdk.incubator.vector.VectorMask.indexInRange.

Doc from jdk.incubator.vector.VectorMask.indexInRange.

Removes lanes numbered N from this mask where the adjusted index N+offset, is not in the range [0..limit-1].

In all cases the series of set and unset lanes is assigned as if by using infinite precision or VLENGTH-saturating additions or subtractions, without overflow or wrap-around.

Annotations

@ForceInline

indexPartiallyInRange	back to summary
pack-priv VectorMask<E> indexPartiallyInRange(int offset, int limit) Annotations @ForceInline

indexPartiallyInRange	back to summary
pack-priv VectorMask<E> indexPartiallyInRange(long offset, long limit) Annotations @ForceInline

indexPartiallyInUpperRange	back to summary
pack-priv abstract VectorMask<E> indexPartiallyInUpperRange(long offset, long limit)

intoArray back to summary

intoArray	back to summary
public void intoArray(boolean[] bits, int i) Implements abstract jdk.incubator.vector.VectorMask.intoArray. Doc from jdk.incubator.vector.VectorMask.intoArray. Stores this mask into a `boolean` array starting at offset. For each mask lane, where `N` is the mask lane index, the lane element at index `N` is stored into the array element `a[offset+N]`. Annotations @Override

public void intoArray(boolean[] bits, int i)

Implements abstract jdk.incubator.vector.VectorMask.intoArray.

Doc from jdk.incubator.vector.VectorMask.intoArray.

Stores this mask into a boolean array starting at offset.

For each mask lane, where N is the mask lane index, the lane element at index N is stored into the array element a[offset+N].

Annotations

@Override

lastTrueHelper	back to summary
pack-priv static int lastTrueHelper(boolean[] bits)

sameSpecies	back to summary
private <F> boolean sameSpecies(Class<? extends VectorMask<F>> maskClass, Vector<F> vector) Annotations @ForceInline

toArray back to summary

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

public boolean[] toArray()

Implements abstract jdk.incubator.vector.VectorMask.toArray.

Doc from jdk.incubator.vector.VectorMask.toArray.

Returns an boolean array containing the lane elements of this mask.

This method behaves as if it stores this mask into an allocated array (using intoArray(boolean[], int)) and returns that array as follows:

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

Annotations

@Override

toLongHelper	back to summary
pack-priv static long toLongHelper(boolean[] bits)

toVectorTemplate	back to summary
pack-priv AbstractVector<E> toVectorTemplate() Annotations @ForceInline

trueCountHelper	back to summary
pack-priv static int trueCountHelper(boolean[] bits)

uOp	back to summary
pack-priv abstract AbstractMask<E> uOp(AbstractMask.MUnOp f)

vectorSpecies	back to summary
public final VectorSpecies<E> vectorSpecies() Implements abstract jdk.incubator.vector.VectorMask.vectorSpecies. Doc from jdk.incubator.vector.VectorMask.vectorSpecies. Returns the vector species to which this mask applies. This mask applies to vectors of the same species, and the same number of lanes. Annotations @Override @ForceInline

vectorSpecies

back to summary

public final VectorSpecies<E> vectorSpecies()

Implements abstract jdk.incubator.vector.VectorMask.vectorSpecies.

Doc from jdk.incubator.vector.VectorMask.vectorSpecies.

Returns the vector species to which this mask applies. This mask applies to vectors of the same species, and the same number of lanes.

Annotations