< prev index next >
src/jdk.incubator.vector/share/classes/jdk/incubator/vector/IntVector.java
Print this page
rev 55237 : javadoc changes
@@ -103,11 +103,12 @@
/**
* Returns a vector where all lane elements are set to the default
* primitive value.
*
- * @return a zero vector
+ * @param species species of desired vector
+ * @return a zero vector of given species
*/
@ForceInline
@SuppressWarnings("unchecked")
public static IntVector zero(IntSpecies species) {
return species.zero();
@@ -124,10 +125,11 @@
* {@link #fromByteBuffer(IntSpecies, ByteBuffer, int, Mask) method} as follows:
* <pre>{@code
* return this.fromByteBuffer(ByteBuffer.wrap(a), i, this.maskAllTrue());
* }</pre>
*
+ * @param species species of desired vector
* @param a the byte array
* @param ix the offset into the array
* @return a vector loaded from a byte array
* @throws IndexOutOfBoundsException if {@code i < 0} or
* {@code i > a.length - (this.length() * this.elementSize() / Byte.SIZE)}
@@ -159,10 +161,11 @@
* {@link #fromByteBuffer(IntSpecies, ByteBuffer, int, Mask) method} as follows:
* <pre>{@code
* return this.fromByteBuffer(ByteBuffer.wrap(a), i, m);
* }</pre>
*
+ * @param species species of desired vector
* @param a the byte array
* @param ix the offset into the array
* @param m the mask
* @return a vector loaded from a byte array
* @throws IndexOutOfBoundsException if {@code i < 0} or
@@ -183,10 +186,11 @@
* <p>
* For each vector lane, where {@code N} is the vector lane index, the
* array element at index {@code i + N} is placed into the
* resulting vector at lane index {@code N}.
*
+ * @param species species of desired vector
* @param a the array
* @param i the offset into the array
* @return the vector loaded from an array
* @throws IndexOutOfBoundsException if {@code i < 0}, or
* {@code i > a.length - this.length()}
@@ -210,10 +214,11 @@
* if the mask lane at index {@code N} is set then the array element at
* index {@code i + N} is placed into the resulting vector at lane index
* {@code N}, otherwise the default element value is placed into the
* resulting vector at lane index {@code N}.
*
+ * @param species species of desired vector
* @param a the array
* @param i the offset into the array
* @param m the mask
* @return the vector loaded from an array
* @throws IndexOutOfBoundsException if {@code i < 0}, or
@@ -231,10 +236,11 @@
* <p>
* For each vector lane, where {@code N} is the vector lane index, the
* array element at index {@code i + indexMap[j + N]} is placed into the
* resulting vector at lane index {@code N}.
*
+ * @param species species of desired vector
* @param a the array
* @param i the offset into the array, may be negative if relative
* indexes in the index map compensate to produce a value within the
* array bounds
* @param indexMap the index map
@@ -270,14 +276,16 @@
* For each vector lane, where {@code N} is the vector lane index,
* if the mask lane at index {@code N} is set then the array element at
* index {@code i + indexMap[j + N]} is placed into the resulting vector
* at lane index {@code N}.
*
+ * @param species species of desired vector
* @param a the array
* @param i the offset into the array, may be negative if relative
* indexes in the index map compensate to produce a value within the
* array bounds
+ * @param m the mask
* @param indexMap the index map
* @param j the offset into the index map
* @return the vector loaded from an array
* @throws IndexOutOfBoundsException if {@code j < 0}, or
* {@code j > indexMap.length - this.length()},
@@ -305,10 +313,11 @@
* {@link #fromByteBuffer(IntSpecies, ByteBuffer, int, Mask)} method} as follows:
* <pre>{@code
* return this.fromByteBuffer(b, i, this.maskAllTrue())
* }</pre>
*
+ * @param species species of desired vector
* @param bb the byte buffer
* @param ix the offset into the byte buffer
* @return a vector loaded from a byte buffer
* @throws IndexOutOfBoundsException if the offset is {@code < 0},
* or {@code > b.limit()},
@@ -356,12 +365,14 @@
* es[n] = eb.get(n);
* }
* Vector<E> r = ((ESpecies<S>)this).fromArray(es, 0, m);
* }</pre>
*
+ * @param species species of desired vector
* @param bb the byte buffer
* @param ix the offset into the byte buffer
+ * @param m the mask
* @return a vector loaded from a byte buffer
* @throws IndexOutOfBoundsException if the offset is {@code < 0},
* or {@code > b.limit()},
* for any vector lane index {@code N} where the mask at lane {@code N}
* is set
@@ -370,10 +381,23 @@
@ForceInline
public static IntVector fromByteBuffer(IntSpecies species, ByteBuffer bb, int ix, Mask<Integer> m) {
return zero(species).blend(fromByteBuffer(species, bb, ix), m);
}
+ /**
+ * Returns a mask where each lane is set or unset according to given
+ * {@code boolean} values
+ * <p>
+ * For each mask lane, where {@code N} is the mask lane index,
+ * if the given {@code boolean} value at index {@code N} is {@code true}
+ * then the mask lane at index {@code N} is set, otherwise it is unset.
+ *
+ * @param species mask species
+ * @param bits the given {@code boolean} values
+ * @return a mask where each lane is set or unset according to the given {@code boolean} value
+ * @throws IndexOutOfBoundsException if {@code bits.length < species.length()}
+ */
@ForceInline
public static Mask<Integer> maskFromValues(IntSpecies species, boolean... bits) {
if (species.boxType() == IntMaxVector.class)
return new IntMaxVector.IntMaxMask(bits);
switch (species.bitSize()) {
@@ -408,10 +432,24 @@
case 512: return Int512Vector.Int512Mask.FALSE_MASK;
default: throw new IllegalArgumentException(Integer.toString(species.bitSize()));
}
}
+ /**
+ * Loads a mask from a {@code boolean} array starting at an offset.
+ * <p>
+ * For each mask lane, where {@code N} is the mask lane index,
+ * if the array element at index {@code i + N} is {@code true} then the
+ * mask lane at index {@code N} is set, otherwise it is unset.
+ *
+ * @param species mask species
+ * @param bits the {@code boolean} array
+ * @param ix the offset into the array
+ * @return the mask loaded from a {@code boolean} array
+ * @throws IndexOutOfBoundsException if {@code ix < 0}, or
+ * {@code ix > bits.length - species.length()}
+ */
@ForceInline
@SuppressWarnings("unchecked")
public static Mask<Integer> maskFromArray(IntSpecies species, boolean[] bits, int ix) {
Objects.requireNonNull(bits);
ix = VectorIntrinsics.checkIndex(ix, bits.length, species.length());
@@ -419,26 +457,62 @@
bits, (((long) ix) << ARRAY_SHIFT) + Unsafe.ARRAY_BOOLEAN_BASE_OFFSET,
bits, ix, species,
(c, idx, s) -> (Mask<Integer>) ((IntSpecies)s).opm(n -> c[idx + n]));
}
+ /**
+ * Returns a mask where all lanes are a set.
+ *
+ * @param species mask species
+ * @return a mask where all lanes are a set
+ */
@ForceInline
@SuppressWarnings("unchecked")
public static Mask<Integer> maskAllTrue(IntSpecies species) {
return VectorIntrinsics.broadcastCoerced((Class<Mask<Integer>>) species.maskType(), int.class, species.length(),
(int)-1, species,
((z, s) -> trueMask((IntSpecies)s)));
}
+ /**
+ * Returns a mask where all lanes are a unset.
+ *
+ * @param species mask species
+ * @return a mask where all lanes are a unset
+ */
@ForceInline
@SuppressWarnings("unchecked")
public static Mask<Integer> maskAllFalse(IntSpecies species) {
return VectorIntrinsics.broadcastCoerced((Class<Mask<Integer>>) species.maskType(), int.class, species.length(),
0, species,
((z, s) -> falseMask((IntSpecies)s)));
}
+ /**
+ * Returns a shuffle of mapped indexes where each lane element is
+ * the result of applying a mapping function to the corresponding lane
+ * index.
+ * <p>
+ * Care should be taken to ensure Shuffle values produced from this
+ * method are consumed as constants to ensure optimal generation of
+ * code. For example, values held in static final fields or values
+ * held in loop constant local variables.
+ * <p>
+ * This method behaves as if a shuffle is created from an array of
+ * mapped indexes as follows:
+ * <pre>{@code
+ * int[] a = new int[species.length()];
+ * for (int i = 0; i < a.length; i++) {
+ * a[i] = f.applyAsInt(i);
+ * }
+ * return this.shuffleFromValues(a);
+ * }</pre>
+ *
+ * @param species shuffle species
+ * @param f the lane index mapping function
+ * @return a shuffle of mapped indexes
+ */
@ForceInline
public static Shuffle<Integer> shuffle(IntSpecies species, IntUnaryOperator f) {
if (species.boxType() == IntMaxVector.class)
return new IntMaxVector.IntMaxShuffle(f);
switch (species.bitSize()) {
@@ -448,10 +522,23 @@
case 512: return new Int512Vector.Int512Shuffle(f);
default: throw new IllegalArgumentException(Integer.toString(species.bitSize()));
}
}
+ /**
+ * Returns a shuffle where each lane element is the value of its
+ * corresponding lane index.
+ * <p>
+ * This method behaves as if a shuffle is created from an identity
+ * index mapping function as follows:
+ * <pre>{@code
+ * return this.shuffle(i -> i);
+ * }</pre>
+ *
+ * @param species shuffle species
+ * @return a shuffle of lane indexes
+ */
@ForceInline
public static Shuffle<Integer> shuffleIota(IntSpecies species) {
if (species.boxType() == IntMaxVector.class)
return new IntMaxVector.IntMaxShuffle(AbstractShuffle.IDENTITY);
switch (species.bitSize()) {
@@ -461,10 +548,26 @@
case 512: return new Int512Vector.Int512Shuffle(AbstractShuffle.IDENTITY);
default: throw new IllegalArgumentException(Integer.toString(species.bitSize()));
}
}
+ /**
+ * Returns a shuffle where each lane element is set to a given
+ * {@code int} value logically AND'ed by the species length minus one.
+ * <p>
+ * For each shuffle lane, where {@code N} is the shuffle lane index, the
+ * the {@code int} value at index {@code N} logically AND'ed by
+ * {@code species.length() - 1} is placed into the resulting shuffle at
+ * lane index {@code N}.
+ *
+ * @param species shuffle species
+ * @param ixs the given {@code int} values
+ * @return a shuffle where each lane element is set to a given
+ * {@code int} value
+ * @throws IndexOutOfBoundsException if the number of int values is
+ * {@code < species.length()}
+ */
@ForceInline
public static Shuffle<Integer> shuffleFromValues(IntSpecies species, int... ixs) {
if (species.boxType() == IntMaxVector.class)
return new IntMaxVector.IntMaxShuffle(ixs);
switch (species.bitSize()) {
@@ -474,10 +577,25 @@
case 512: return new Int512Vector.Int512Shuffle(ixs);
default: throw new IllegalArgumentException(Integer.toString(species.bitSize()));
}
}
+ /**
+ * Loads a shuffle from an {@code int} array starting at an offset.
+ * <p>
+ * For each shuffle lane, where {@code N} is the shuffle lane index, the
+ * array element at index {@code i + N} logically AND'ed by
+ * {@code species.length() - 1} is placed into the resulting shuffle at lane
+ * index {@code N}.
+ *
+ * @param species shuffle species
+ * @param ixs the {@code int} array
+ * @param i the offset into the array
+ * @return a shuffle loaded from the {@code int} array
+ * @throws IndexOutOfBoundsException if {@code i < 0}, or
+ * {@code i > a.length - species.length()}
+ */
@ForceInline
public static Shuffle<Integer> shuffleFromArray(IntSpecies species, int[] ixs, int i) {
if (species.boxType() == IntMaxVector.class)
return new IntMaxVector.IntMaxShuffle(ixs, i);
switch (species.bitSize()) {
@@ -1016,10 +1134,11 @@
* <p>
* This is a vector binary operation where the primitive logical right shift
* operation ({@code >>>}) is applied to lane elements.
*
* @param s the input scalar; the number of the bits to right shift
+ * @param m the mask controlling lane selection
* @return the result of logically right shifting this vector by the
* broadcast of an input scalar
*/
public abstract IntVector shiftR(int s, Mask<Integer> m);
@@ -1197,11 +1316,10 @@
@Override
public abstract void intoByteBuffer(ByteBuffer bb, int ix, Mask<Integer> m);
// Type specific horizontal reductions
-
/**
* Adds all lane elements of this vector.
* <p>
* This is an associative vector reduction operation where the addition
* operation ({@code +}) is applied to lane elements,
@@ -1218,39 +1336,15 @@
* This is an associative vector reduction operation where the addition
* operation ({@code +}) is applied to lane elements,
* and the identity value is {@code 0}.
*
* @param m the mask controlling lane selection
- * @return the addition of all the lane elements of this vector
+ * @return the addition of the selected lane elements of this vector
*/
public abstract int addAll(Mask<Integer> m);
/**
- * Subtracts all lane elements of this vector.
- * <p>
- * This is an associative vector reduction operation where the subtraction
- * operation ({@code -}) is applied to lane elements,
- * and the identity value is {@code 0}.
- *
- * @return the subtraction of all the lane elements of this vector
- */
- public abstract int subAll();
-
- /**
- * Subtracts all lane elements of this vector, selecting lane elements
- * controlled by a mask.
- * <p>
- * This is an associative vector reduction operation where the subtraction
- * operation ({@code -}) is applied to lane elements,
- * and the identity value is {@code 0}.
- *
- * @param m the mask controlling lane selection
- * @return the subtraction of all the lane elements of this vector
- */
- public abstract int subAll(Mask<Integer> m);
-
- /**
* Multiplies all lane elements of this vector.
* <p>
* This is an associative vector reduction operation where the
* multiplication operation ({@code *}) is applied to lane elements,
* and the identity value is {@code 1}.
@@ -1275,11 +1369,12 @@
/**
* Returns the minimum lane element of this vector.
* <p>
* This is an associative vector reduction operation where the operation
* {@code (a, b) -> Math.min(a, b)} is applied to lane elements,
- * and the identity value is {@link Integer#MAX_VALUE}.
+ * and the identity value is
+ * {@link Integer#MAX_VALUE}.
*
* @return the minimum lane element of this vector
*/
public abstract int minAll();
@@ -1287,11 +1382,12 @@
* Returns the minimum lane element of this vector, selecting lane elements
* controlled by a mask.
* <p>
* This is an associative vector reduction operation where the operation
* {@code (a, b) -> Math.min(a, b)} is applied to lane elements,
- * and the identity value is {@link Integer#MAX_VALUE}.
+ * and the identity value is
+ * {@link Integer#MAX_VALUE}.
*
* @param m the mask controlling lane selection
* @return the minimum lane element of this vector
*/
public abstract int minAll(Mask<Integer> m);
@@ -1299,11 +1395,12 @@
/**
* Returns the maximum lane element of this vector.
* <p>
* This is an associative vector reduction operation where the operation
* {@code (a, b) -> Math.max(a, b)} is applied to lane elements,
- * and the identity value is {@link Integer#MIN_VALUE}.
+ * and the identity value is
+ * {@link Integer#MIN_VALUE}.
*
* @return the maximum lane element of this vector
*/
public abstract int maxAll();
@@ -1311,11 +1408,12 @@
* Returns the maximum lane element of this vector, selecting lane elements
* controlled by a mask.
* <p>
* This is an associative vector reduction operation where the operation
* {@code (a, b) -> Math.max(a, b)} is applied to lane elements,
- * and the identity value is {@link Integer#MIN_VALUE}.
+ * and the identity value is
+ * {@link Integer#MIN_VALUE}.
*
* @param m the mask controlling lane selection
* @return the maximum lane element of this vector
*/
public abstract int maxAll(Mask<Integer> m);
@@ -1578,11 +1676,11 @@
/**
* Returns a vector where each lane element is set to a randomly
* generated primitive value.
*
* The semantics are equivalent to calling
- * {@link (int)ThreadLocalRandom#nextInt() }
+ * {@code (int)ThreadLocalRandom#nextInt()}.
*
* @return a vector where each lane elements is set to a randomly
* generated primitive value
*/
public IntVector random() {
< prev index next >