rev 55237 : javadoc changes

*** 103,113 **** /** * Returns a vector where all lane elements are set to the default * primitive value. * ! * @return a zero vector */ @ForceInline @SuppressWarnings("unchecked") public static ShortVector zero(ShortSpecies species) { return species.zero(); --- 103,114 ---- /** * Returns a vector where all lane elements are set to the default * primitive value. * ! * @param species species of desired vector ! * @return a zero vector of given species */ @ForceInline @SuppressWarnings("unchecked") public static ShortVector zero(ShortSpecies species) { return species.zero();

*** 124,133 **** --- 125,135 ---- * {@link #fromByteBuffer(ShortSpecies, 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,168 **** --- 161,171 ---- * {@link #fromByteBuffer(ShortSpecies, 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,192 **** --- 186,196 ---- * <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,219 **** --- 214,224 ---- * 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,240 **** --- 236,246 ---- * <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

*** 255,268 **** --- 261,276 ---- * 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()},

*** 286,295 **** --- 294,304 ---- * {@link #fromByteBuffer(ShortSpecies, 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()},

*** 337,348 **** --- 346,359 ---- * 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

*** 351,360 **** --- 362,384 ---- @ForceInline public static ShortVector fromByteBuffer(ShortSpecies species, ByteBuffer bb, int ix, Mask<Short> 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<Short> maskFromValues(ShortSpecies species, boolean... bits) { if (species.boxType() == ShortMaxVector.class) return new ShortMaxVector.ShortMaxMask(bits); switch (species.bitSize()) {

*** 389,398 **** --- 413,436 ---- case 512: return Short512Vector.Short512Mask.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<Short> maskFromArray(ShortSpecies species, boolean[] bits, int ix) { Objects.requireNonNull(bits); ix = VectorIntrinsics.checkIndex(ix, bits.length, species.length());

*** 400,425 **** --- 438,499 ---- bits, (((long) ix) << ARRAY_SHIFT) + Unsafe.ARRAY_BOOLEAN_BASE_OFFSET, bits, ix, species, (c, idx, s) -> (Mask<Short>) ((ShortSpecies)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<Short> maskAllTrue(ShortSpecies species) { return VectorIntrinsics.broadcastCoerced((Class<Mask<Short>>) species.maskType(), short.class, species.length(), (short)-1, species, ((z, s) -> trueMask((ShortSpecies)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<Short> maskAllFalse(ShortSpecies species) { return VectorIntrinsics.broadcastCoerced((Class<Mask<Short>>) species.maskType(), short.class, species.length(), 0, species, ((z, s) -> falseMask((ShortSpecies)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<Short> shuffle(ShortSpecies species, IntUnaryOperator f) { if (species.boxType() == ShortMaxVector.class) return new ShortMaxVector.ShortMaxShuffle(f); switch (species.bitSize()) {

*** 429,438 **** --- 503,525 ---- case 512: return new Short512Vector.Short512Shuffle(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<Short> shuffleIota(ShortSpecies species) { if (species.boxType() == ShortMaxVector.class) return new ShortMaxVector.ShortMaxShuffle(AbstractShuffle.IDENTITY); switch (species.bitSize()) {

*** 442,451 **** --- 529,554 ---- case 512: return new Short512Vector.Short512Shuffle(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<Short> shuffleFromValues(ShortSpecies species, int... ixs) { if (species.boxType() == ShortMaxVector.class) return new ShortMaxVector.ShortMaxShuffle(ixs); switch (species.bitSize()) {

*** 455,464 **** --- 558,582 ---- case 512: return new Short512Vector.Short512Shuffle(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<Short> shuffleFromArray(ShortSpecies species, int[] ixs, int i) { if (species.boxType() == ShortMaxVector.class) return new ShortMaxVector.ShortMaxShuffle(ixs, i); switch (species.bitSize()) {

*** 926,936 **** * <p> * This is a vector binary operation where the primitive logical left shift * operation ({@code <<}) is applied to lane elements to left shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator & with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to left shift * @return the result of logically left shifting left this vector by the * broadcast of an input scalar --- 1044,1054 ---- * <p> * This is a vector binary operation where the primitive logical left shift * operation ({@code <<}) is applied to lane elements to left shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator ({@code &}) with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to left shift * @return the result of logically left shifting left this vector by the * broadcast of an input scalar

*** 943,953 **** * <p> * This is a vector binary operation where the primitive logical left shift * operation ({@code <<}) is applied to lane elements to left shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator & with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to left shift * @param m the mask controlling lane selection * @return the result of logically left shifting left this vector by the --- 1061,1071 ---- * <p> * This is a vector binary operation where the primitive logical left shift * operation ({@code <<}) is applied to lane elements to left shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator ({@code &}) with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to left shift * @param m the mask controlling lane selection * @return the result of logically left shifting left this vector by the

*** 964,974 **** * <p> * This is a vector binary operation where the primitive logical right shift * operation ({@code >>>}) is applied to lane elements to logically right shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator & with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to right shift * @return the result of logically right shifting this vector by the * broadcast of an input scalar --- 1082,1092 ---- * <p> * This is a vector binary operation where the primitive logical right shift * operation ({@code >>>}) is applied to lane elements to logically right shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator ({@code &}) with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to right shift * @return the result of logically right shifting this vector by the * broadcast of an input scalar

*** 982,995 **** * <p> * This is a vector binary operation where the primitive logical right shift * operation ({@code >>>}) is applied to lane elements to logically right shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator & with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to right shift * @return the result of logically right shifting this vector by the * broadcast of an input scalar */ public abstract ShortVector shiftR(int s, Mask<Short> m); --- 1100,1114 ---- * <p> * This is a vector binary operation where the primitive logical right shift * operation ({@code >>>}) is applied to lane elements to logically right shift the * element by shift value as specified by the input scalar. Only the 4 * lowest-order bits of shift value are used. It is as if the shift value ! * were subjected to a bitwise logical AND operator ({@code &}) with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @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 ShortVector shiftR(int s, Mask<Short> m);

*** 1000,1010 **** * <p> * This is a vector binary operation where the primitive arithmetic right * shift operation ({@code >>}) is applied to lane elements to arithmetically * right shift the element by shift value as specified by the input scalar. * Only the 4 lowest-order bits of shift value are used. It is as if the shift ! * value were subjected to a bitwise logical AND operator & with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to right shift * @return the result of arithmetically right shifting this vector by the * broadcast of an input scalar --- 1119,1129 ---- * <p> * This is a vector binary operation where the primitive arithmetic right * shift operation ({@code >>}) is applied to lane elements to arithmetically * right shift the element by shift value as specified by the input scalar. * Only the 4 lowest-order bits of shift value are used. It is as if the shift ! * value were subjected to a bitwise logical AND operator ({@code &}) with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to right shift * @return the result of arithmetically right shifting this vector by the * broadcast of an input scalar

*** 1018,1028 **** * <p> * This is a vector binary operation where the primitive arithmetic right * shift operation ({@code >>}) is applied to lane elements to arithmetically * right shift the element by shift value as specified by the input scalar. * Only the 4 lowest-order bits of shift value are used. It is as if the shift ! * value were subjected to a bitwise logical AND operator & with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to right shift * @param m the mask controlling lane selection * @return the result of arithmetically right shifting this vector by the --- 1137,1147 ---- * <p> * This is a vector binary operation where the primitive arithmetic right * shift operation ({@code >>}) is applied to lane elements to arithmetically * right shift the element by shift value as specified by the input scalar. * Only the 4 lowest-order bits of shift value are used. It is as if the shift ! * value were subjected to a bitwise logical AND operator ({@code &}) with the mask value 0xF. * The shift distance actually used is therefore always in the range 0 to 15, inclusive. * * @param s the input scalar; the number of the bits to right shift * @param m the mask controlling lane selection * @return the result of arithmetically right shifting this vector by the

*** 1043,1053 **** @Override public abstract void intoByteBuffer(ByteBuffer bb, int ix, Mask<Short> 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, --- 1162,1171 ----

*** 1064,1102 **** * 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 */ public abstract short addAll(Mask<Short> 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 short 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 short subAll(Mask<Short> 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}. --- 1182,1196 ---- * 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 the selected lane elements of this vector */ public abstract short addAll(Mask<Short> 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}.

*** 1121,1131 **** /** * 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 Short#MAX_VALUE}. * * @return the minimum lane element of this vector */ public abstract short minAll(); --- 1215,1226 ---- /** * 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 Short#MAX_VALUE}. * * @return the minimum lane element of this vector */ public abstract short minAll();

*** 1133,1143 **** * 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 Short#MAX_VALUE}. * * @param m the mask controlling lane selection * @return the minimum lane element of this vector */ public abstract short minAll(Mask<Short> m); --- 1228,1239 ---- * 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 Short#MAX_VALUE}. * * @param m the mask controlling lane selection * @return the minimum lane element of this vector */ public abstract short minAll(Mask<Short> m);

*** 1145,1155 **** /** * 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 Short#MIN_VALUE}. * * @return the maximum lane element of this vector */ public abstract short maxAll(); --- 1241,1252 ---- /** * 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 Short#MIN_VALUE}. * * @return the maximum lane element of this vector */ public abstract short maxAll();

*** 1157,1167 **** * 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 Short#MIN_VALUE}. * * @param m the mask controlling lane selection * @return the maximum lane element of this vector */ public abstract short maxAll(Mask<Short> m); --- 1254,1265 ---- * 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 Short#MIN_VALUE}. * * @param m the mask controlling lane selection * @return the maximum lane element of this vector */ public abstract short maxAll(Mask<Short> m);

*** 1427,1437 **** /** * Returns a vector where each lane element is set to a randomly * generated primitive value. * * The semantics are equivalent to calling ! * {@link (short)ThreadLocalRandom#nextInt() } * * @return a vector where each lane elements is set to a randomly * generated primitive value */ public ShortVector random() { --- 1525,1535 ---- /** * Returns a vector where each lane element is set to a randomly * generated primitive value. * * The semantics are equivalent to calling ! * {@code (short)ThreadLocalRandom#nextInt()}. * * @return a vector where each lane elements is set to a randomly * generated primitive value */ public ShortVector random() {