< prev index next >
src/jdk.incubator.vector/share/classes/jdk/incubator/vector/DoubleVector.java
Print this page
rev 54658 : refactored mask and shuffle creation methods, moved classes to top-level
rev 54660 : Javadoc changes
@@ -123,30 +123,30 @@
* Bytes are composed into primitive lane elements according to the
* native byte order of the underlying platform
* <p>
* This method behaves as if it returns the result of calling the
* byte buffer, offset, and mask accepting
- * {@link #fromByteBuffer(VectorSpecies<Double>, ByteBuffer, int, VectorMask) method} as follows:
+ * {@link #fromByteBuffer(VectorSpecies, ByteBuffer, int, VectorMask) method} as follows:
* <pre>{@code
- * return this.fromByteBuffer(ByteBuffer.wrap(a), i, this.maskAllTrue());
+ * return fromByteBuffer(species, ByteBuffer.wrap(a), offset, VectorMask.allTrue());
* }</pre>
*
* @param species species of desired vector
* @param a the byte array
- * @param ix the offset into the array
+ * @param offset 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)}
+ * {@code offset > a.length - (species.length() * species.elementSize() / Byte.SIZE)}
*/
@ForceInline
@SuppressWarnings("unchecked")
- public static DoubleVector fromByteArray(VectorSpecies<Double> species, byte[] a, int ix) {
+ public static DoubleVector fromByteArray(VectorSpecies<Double> species, byte[] a, int offset) {
Objects.requireNonNull(a);
- ix = VectorIntrinsics.checkIndex(ix, a.length, species.bitSize() / Byte.SIZE);
+ offset = VectorIntrinsics.checkIndex(offset, a.length, species.bitSize() / Byte.SIZE);
return VectorIntrinsics.load((Class<DoubleVector>) species.boxType(), double.class, species.length(),
- a, ((long) ix) + Unsafe.ARRAY_BYTE_BASE_OFFSET,
- a, ix, species,
+ a, ((long) offset) + Unsafe.ARRAY_BYTE_BASE_OFFSET,
+ a, offset, species,
(c, idx, s) -> {
ByteBuffer bbc = ByteBuffer.wrap(c, idx, a.length - idx).order(ByteOrder.nativeOrder());
DoubleBuffer tb = bbc.asDoubleBuffer();
return ((DoubleSpecies)s).op(i -> tb.get());
});
@@ -159,154 +159,151 @@
* Bytes are composed into primitive lane elements according to the
* native byte order of the underlying platform.
* <p>
* This method behaves as if it returns the result of calling the
* byte buffer, offset, and mask accepting
- * {@link #fromByteBuffer(VectorSpecies<Double>, ByteBuffer, int, VectorMask) method} as follows:
+ * {@link #fromByteBuffer(VectorSpecies, ByteBuffer, int, VectorMask) method} as follows:
* <pre>{@code
- * return this.fromByteBuffer(ByteBuffer.wrap(a), i, m);
+ * return fromByteBuffer(species, ByteBuffer.wrap(a), offset, m);
* }</pre>
*
* @param species species of desired vector
* @param a the byte array
- * @param ix the offset into the array
+ * @param offset the offset into the array
* @param m the mask
* @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)}
- * @throws IndexOutOfBoundsException if the offset is {@code < 0},
- * or {@code > a.length},
+ * @throws IndexOutOfBoundsException if {@code offset < 0} or
* for any vector lane index {@code N} where the mask at lane {@code N}
* is set
- * {@code i >= a.length - (N * this.elementSize() / Byte.SIZE)}
+ * {@code offset >= a.length - (N * species.elementSize() / Byte.SIZE)}
*/
@ForceInline
- public static DoubleVector fromByteArray(VectorSpecies<Double> species, byte[] a, int ix, VectorMask<Double> m) {
- return zero(species).blend(fromByteArray(species, a, ix), m);
+ public static DoubleVector fromByteArray(VectorSpecies<Double> species, byte[] a, int offset, VectorMask<Double> m) {
+ return zero(species).blend(fromByteArray(species, a, offset), m);
}
/**
* Loads a vector from an array starting at offset.
* <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
+ * array element at index {@code offset + 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
+ * @param offset 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()}
+ * @throws IndexOutOfBoundsException if {@code offset < 0}, or
+ * {@code offset > a.length - species.length()}
*/
@ForceInline
@SuppressWarnings("unchecked")
- public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int i){
+ public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int offset){
Objects.requireNonNull(a);
- i = VectorIntrinsics.checkIndex(i, a.length, species.length());
+ offset = VectorIntrinsics.checkIndex(offset, a.length, species.length());
return VectorIntrinsics.load((Class<DoubleVector>) species.boxType(), double.class, species.length(),
- a, (((long) i) << ARRAY_SHIFT) + Unsafe.ARRAY_DOUBLE_BASE_OFFSET,
- a, i, species,
+ a, (((long) offset) << ARRAY_SHIFT) + Unsafe.ARRAY_DOUBLE_BASE_OFFSET,
+ a, offset, species,
(c, idx, s) -> ((DoubleSpecies)s).op(n -> c[idx + n]));
}
/**
* Loads a vector from an array starting at offset and using a mask.
* <p>
* 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 + N} is placed into the resulting vector at lane index
+ * index {@code offset + 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 offset the offset into the array
* @param m the mask
* @return the vector loaded from an array
- * @throws IndexOutOfBoundsException if {@code i < 0}, or
+ * @throws IndexOutOfBoundsException if {@code offset < 0}, or
* for any vector lane index {@code N} where the mask at lane {@code N}
- * is set {@code i > a.length - N}
+ * is set {@code offset > a.length - N}
*/
@ForceInline
- public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int i, VectorMask<Double> m) {
- return zero(species).blend(fromArray(species, a, i), m);
+ public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int offset, VectorMask<Double> m) {
+ return zero(species).blend(fromArray(species, a, offset), m);
}
/**
* Loads a vector from an array using indexes obtained from an index
* map.
* <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
+ * array element at index {@code a_offset + indexMap[i_offset + 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
+ * @param a_offset 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
- * @param j the offset into the index map
+ * @param i_offset 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()},
+ * @throws IndexOutOfBoundsException if {@code i_offset < 0}, or
+ * {@code i_offset > indexMap.length - species.length()},
* or for any vector lane index {@code N} the result of
- * {@code i + indexMap[j + N]} is {@code < 0} or {@code >= a.length}
+ * {@code a_offset + indexMap[i_offset + N]} is {@code < 0} or {@code >= a.length}
*/
@ForceInline
@SuppressWarnings("unchecked")
- public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int i, int[] indexMap, int j) {
+ public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int a_offset, int[] indexMap, int i_offset) {
Objects.requireNonNull(a);
Objects.requireNonNull(indexMap);
if (species.length() == 1) {
- return DoubleVector.fromArray(species, a, i + indexMap[j]);
+ return DoubleVector.fromArray(species, a, a_offset + indexMap[i_offset]);
}
- // Index vector: vix[0:n] = k -> i + indexMap[j + k]
- IntVector vix = IntVector.fromArray(IntVector.species(species.indexShape()), indexMap, j).add(i);
+ // Index vector: vix[0:n] = k -> a_offset + indexMap[i_offset + k]
+ IntVector vix = IntVector.fromArray(IntVector.species(species.indexShape()), indexMap, i_offset).add(a_offset);
vix = VectorIntrinsics.checkIndex(vix, a.length);
return VectorIntrinsics.loadWithMap((Class<DoubleVector>) species.boxType(), double.class, species.length(),
IntVector.species(species.indexShape()).boxType(), a, Unsafe.ARRAY_DOUBLE_BASE_OFFSET, vix,
- a, i, indexMap, j, species,
+ a, a_offset, indexMap, i_offset, species,
(double[] c, int idx, int[] iMap, int idy, VectorSpecies<Double> s) ->
((DoubleSpecies)s).op(n -> c[idx + iMap[idy+n]]));
}
/**
* Loads a vector from an array using indexes obtained from an index
* map and using a mask.
* <p>
* 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
+ * index {@code a_offset + indexMap[i_offset + 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
+ * @param a_offset 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
+ * @param i_offset 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()},
+ * @throws IndexOutOfBoundsException if {@code i_offset < 0}, or
+ * {@code i_offset > indexMap.length - species.length()},
* or for any vector lane index {@code N} where the mask at lane
- * {@code N} is set the result of {@code i + indexMap[j + N]} is
+ * {@code N} is set the result of {@code a_offset + indexMap[i_offset + N]} is
* {@code < 0} or {@code >= a.length}
*/
@ForceInline
@SuppressWarnings("unchecked")
- public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int i, VectorMask<Double> m, int[] indexMap, int j) {
+ public static DoubleVector fromArray(VectorSpecies<Double> species, double[] a, int a_offset, VectorMask<Double> m, int[] indexMap, int i_offset) {
// @@@ This can result in out of bounds errors for unset mask lanes
- return zero(species).blend(fromArray(species, a, i, indexMap, j), m);
+ return zero(species).blend(fromArray(species, a, a_offset, indexMap, i_offset), m);
}
/**
* Loads a vector from a {@link ByteBuffer byte buffer} starting at an
@@ -315,35 +312,35 @@
* Bytes are composed into primitive lane elements according to the
* native byte order of the underlying platform.
* <p>
* This method behaves as if it returns the result of calling the
* byte buffer, offset, and mask accepting
- * {@link #fromByteBuffer(VectorSpecies<Double>, ByteBuffer, int, VectorMask)} method} as follows:
+ * {@link #fromByteBuffer(VectorSpecies, ByteBuffer, int, VectorMask)} method} as follows:
* <pre>{@code
- * return this.fromByteBuffer(b, i, this.maskAllTrue())
+ * return fromByteBuffer(b, offset, VectorMask.allTrue())
* }</pre>
*
* @param species species of desired vector
* @param bb the byte buffer
- * @param ix the offset into the byte buffer
+ * @param offset 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()},
* or if there are fewer than
- * {@code this.length() * this.elementSize() / Byte.SIZE} bytes
+ * {@code species.length() * species.elementSize() / Byte.SIZE} bytes
* remaining in the byte buffer from the given offset
*/
@ForceInline
@SuppressWarnings("unchecked")
- public static DoubleVector fromByteBuffer(VectorSpecies<Double> species, ByteBuffer bb, int ix) {
+ public static DoubleVector fromByteBuffer(VectorSpecies<Double> species, ByteBuffer bb, int offset) {
if (bb.order() != ByteOrder.nativeOrder()) {
throw new IllegalArgumentException();
}
- ix = VectorIntrinsics.checkIndex(ix, bb.limit(), species.bitSize() / Byte.SIZE);
+ offset = VectorIntrinsics.checkIndex(offset, bb.limit(), species.bitSize() / Byte.SIZE);
return VectorIntrinsics.load((Class<DoubleVector>) species.boxType(), double.class, species.length(),
- U.getReference(bb, BYTE_BUFFER_HB), U.getLong(bb, BUFFER_ADDRESS) + ix,
- bb, ix, species,
+ U.getReference(bb, BYTE_BUFFER_HB), U.getLong(bb, BUFFER_ADDRESS) + offset,
+ bb, offset, species,
(c, idx, s) -> {
ByteBuffer bbc = c.duplicate().position(idx).order(ByteOrder.nativeOrder());
DoubleBuffer tb = bbc.asDoubleBuffer();
return ((DoubleSpecies)s).op(i -> tb.get());
});
@@ -357,125 +354,125 @@
* {@link java.nio.Buffer buffer} for the primitive element type,
* according to the native byte order of the underlying platform, and
* the returned vector is loaded with a mask from a primitive array
* obtained from the primitive buffer.
* The following pseudocode expresses the behaviour, where
- * {@coce EBuffer} is the primitive buffer type, {@code e} is the
- * primitive element type, and {@code ESpecies<S>} is the primitive
+ * {@code EBuffer} is the primitive buffer type, {@code e} is the
+ * primitive element type, and {@code ESpecies} is the primitive
* species for {@code e}:
* <pre>{@code
* EBuffer eb = b.duplicate().
- * order(ByteOrder.nativeOrder()).position(i).
+ * order(ByteOrder.nativeOrder()).position(offset).
* asEBuffer();
- * e[] es = new e[this.length()];
+ * e[] es = new e[species.length()];
* for (int n = 0; n < t.length; n++) {
* if (m.isSet(n))
* es[n] = eb.get(n);
* }
- * Vector<E> r = ((ESpecies<S>)this).fromArray(es, 0, m);
+ * EVector r = EVector.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 offset 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
- * {@code i >= b.limit() - (N * this.elementSize() / Byte.SIZE)}
+ * {@code offset >= b.limit() - (N * species.elementSize() / Byte.SIZE)}
*/
@ForceInline
- public static DoubleVector fromByteBuffer(VectorSpecies<Double> species, ByteBuffer bb, int ix, VectorMask<Double> m) {
- return zero(species).blend(fromByteBuffer(species, bb, ix), m);
+ public static DoubleVector fromByteBuffer(VectorSpecies<Double> species, ByteBuffer bb, int offset, VectorMask<Double> m) {
+ return zero(species).blend(fromByteBuffer(species, bb, offset), m);
}
/**
* Returns a vector where all lane elements are set to the primitive
* value {@code e}.
*
- * @param s species of the desired vector
+ * @param species species of the desired vector
* @param e the value
* @return a vector of vector where all lane elements are set to
* the primitive value {@code e}
*/
@ForceInline
@SuppressWarnings("unchecked")
- public static DoubleVector broadcast(VectorSpecies<Double> s, double e) {
+ public static DoubleVector broadcast(VectorSpecies<Double> species, double e) {
return VectorIntrinsics.broadcastCoerced(
- (Class<DoubleVector>) s.boxType(), double.class, s.length(),
- Double.doubleToLongBits(e), s,
+ (Class<DoubleVector>) species.boxType(), double.class, species.length(),
+ Double.doubleToLongBits(e), species,
((bits, sp) -> ((DoubleSpecies)sp).op(i -> Double.longBitsToDouble((long)bits))));
}
/**
- * Returns a vector where each lane element is set to a given
- * primitive value.
+ * Returns a vector where each lane element is set to given
+ * primitive values.
* <p>
* For each vector lane, where {@code N} is the vector lane index, the
* the primitive value at index {@code N} is placed into the resulting
* vector at lane index {@code N}.
*
- * @param s species of the desired vector
+ * @param species species of the desired vector
* @param es the given primitive values
- * @return a vector where each lane element is set to a given primitive
- * value
- * @throws IndexOutOfBoundsException if {@code es.length < this.length()}
+ * @return a vector where each lane element is set to given primitive
+ * values
+ * @throws IndexOutOfBoundsException if {@code es.length < species.length()}
*/
@ForceInline
@SuppressWarnings("unchecked")
- public static DoubleVector scalars(VectorSpecies<Double> s, double... es) {
+ public static DoubleVector scalars(VectorSpecies<Double> species, double... es) {
Objects.requireNonNull(es);
- int ix = VectorIntrinsics.checkIndex(0, es.length, s.length());
- return VectorIntrinsics.load((Class<DoubleVector>) s.boxType(), double.class, s.length(),
+ int ix = VectorIntrinsics.checkIndex(0, es.length, species.length());
+ return VectorIntrinsics.load((Class<DoubleVector>) species.boxType(), double.class, species.length(),
es, Unsafe.ARRAY_DOUBLE_BASE_OFFSET,
- es, ix, s,
+ es, ix, species,
(c, idx, sp) -> ((DoubleSpecies)sp).op(n -> c[idx + n]));
}
/**
* Returns a vector where the first lane element is set to the primtive
* value {@code e}, all other lane elements are set to the default
* value.
*
- * @param s species of the desired vector
+ * @param species species of the desired vector
* @param e the value
* @return a vector where the first lane element is set to the primitive
* value {@code e}
*/
@ForceInline
- public static final DoubleVector single(VectorSpecies<Double> s, double e) {
- return zero(s).with(0, e);
+ public static final DoubleVector single(VectorSpecies<Double> species, double e) {
+ return zero(species).with(0, e);
}
/**
* Returns a vector where each lane element is set to a randomly
* generated primitive value.
*
* The semantics are equivalent to calling
* {@link ThreadLocalRandom#nextDouble()}
*
- * @param s species of the desired vector
+ * @param species species of the desired vector
* @return a vector where each lane elements is set to a randomly
* generated primitive value
*/
- public static DoubleVector random(VectorSpecies<Double> s) {
+ public static DoubleVector random(VectorSpecies<Double> species) {
ThreadLocalRandom r = ThreadLocalRandom.current();
- return ((DoubleSpecies)s).op(i -> r.nextDouble());
+ return ((DoubleSpecies)species).op(i -> r.nextDouble());
}
// Ops
@Override
public abstract DoubleVector add(Vector<Double> v);
/**
* Adds this vector to the broadcast of an input scalar.
* <p>
- * This is a vector binary operation where the primitive addition operation
- * ({@code +}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive addition operation
+ * ({@code +}) to each lane.
*
* @param s the input scalar
* @return the result of adding this vector to the broadcast of an input
* scalar
*/
@@ -486,12 +483,12 @@
/**
* Adds this vector to broadcast of an input scalar,
* selecting lane elements controlled by a mask.
* <p>
- * This is a vector binary operation where the primitive addition operation
- * ({@code +}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive addition operation
+ * ({@code +}) to each lane.
*
* @param s the input scalar
* @param m the mask controlling lane selection
* @return the result of adding this vector to the broadcast of an input
* scalar
@@ -502,12 +499,12 @@
public abstract DoubleVector sub(Vector<Double> v);
/**
* Subtracts the broadcast of an input scalar from this vector.
* <p>
- * This is a vector binary operation where the primitive subtraction
- * operation ({@code -}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive subtraction
+ * operation ({@code -}) to each lane.
*
* @param s the input scalar
* @return the result of subtracting the broadcast of an input
* scalar from this vector
*/
@@ -518,12 +515,12 @@
/**
* Subtracts the broadcast of an input scalar from this vector, selecting
* lane elements controlled by a mask.
* <p>
- * This is a vector binary operation where the primitive subtraction
- * operation ({@code -}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive subtraction
+ * operation ({@code -}) to each lane.
*
* @param s the input scalar
* @param m the mask controlling lane selection
* @return the result of subtracting the broadcast of an input
* scalar from this vector
@@ -534,12 +531,12 @@
public abstract DoubleVector mul(Vector<Double> v);
/**
* Multiplies this vector with the broadcast of an input scalar.
* <p>
- * This is a vector binary operation where the primitive multiplication
- * operation ({@code *}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive multiplication
+ * operation ({@code *}) to each lane.
*
* @param s the input scalar
* @return the result of multiplying this vector with the broadcast of an
* input scalar
*/
@@ -550,12 +547,12 @@
/**
* Multiplies this vector with the broadcast of an input scalar, selecting
* lane elements controlled by a mask.
* <p>
- * This is a vector binary operation where the primitive multiplication
- * operation ({@code *}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive multiplication
+ * operation ({@code *}) to each lane.
*
* @param s the input scalar
* @param m the mask controlling lane selection
* @return the result of multiplying this vector with the broadcast of an
* input scalar
@@ -581,12 +578,12 @@
public abstract DoubleVector min(Vector<Double> v, VectorMask<Double> m);
/**
* Returns the minimum of this vector and the broadcast of an input scalar.
* <p>
- * This is a vector binary operation where the operation
- * {@code (a, b) -> Math.min(a, b)} is applied to lane elements.
+ * This is a lane-wise binary operation which applies the operation
+ * {@code (a, b) -> Math.min(a, b)} to each lane.
*
* @param s the input scalar
* @return the minimum of this vector and the broadcast of an input scalar
*/
public abstract DoubleVector min(double s);
@@ -598,12 +595,12 @@
public abstract DoubleVector max(Vector<Double> v, VectorMask<Double> m);
/**
* Returns the maximum of this vector and the broadcast of an input scalar.
* <p>
- * This is a vector binary operation where the operation
- * {@code (a, b) -> Math.max(a, b)} is applied to lane elements.
+ * This is a lane-wise binary operation which applies the operation
+ * {@code (a, b) -> Math.max(a, b)} to each lane.
*
* @param s the input scalar
* @return the maximum of this vector and the broadcast of an input scalar
*/
public abstract DoubleVector max(double s);
@@ -612,12 +609,12 @@
public abstract VectorMask<Double> equal(Vector<Double> v);
/**
* Tests if this vector is equal to the broadcast of an input scalar.
* <p>
- * This is a vector binary test operation where the primitive equals
- * operation ({@code ==}) is applied to lane elements.
+ * This is a lane-wise binary test operation which applies the primitive equals
+ * operation ({@code ==}) each lane.
*
* @param s the input scalar
* @return the result mask of testing if this vector is equal to the
* broadcast of an input scalar
*/
@@ -627,12 +624,12 @@
public abstract VectorMask<Double> notEqual(Vector<Double> v);
/**
* Tests if this vector is not equal to the broadcast of an input scalar.
* <p>
- * This is a vector binary test operation where the primitive not equals
- * operation ({@code !=}) is applied to lane elements.
+ * This is a lane-wise binary test operation which applies the primitive not equals
+ * operation ({@code !=}) to each lane.
*
* @param s the input scalar
* @return the result mask of testing if this vector is not equal to the
* broadcast of an input scalar
*/
@@ -642,12 +639,12 @@
public abstract VectorMask<Double> lessThan(Vector<Double> v);
/**
* Tests if this vector is less than the broadcast of an input scalar.
* <p>
- * This is a vector binary test operation where the primitive less than
- * operation ({@code <}) is applied to lane elements.
+ * This is a lane-wise binary test operation which applies the primitive less than
+ * operation ({@code <}) to each lane.
*
* @param s the input scalar
* @return the mask result of testing if this vector is less than the
* broadcast of an input scalar
*/
@@ -657,12 +654,12 @@
public abstract VectorMask<Double> lessThanEq(Vector<Double> v);
/**
* Tests if this vector is less or equal to the broadcast of an input scalar.
* <p>
- * This is a vector binary test operation where the primitive less than
- * or equal to operation ({@code <=}) is applied to lane elements.
+ * This is a lane-wise binary test operation which applies the primitive less than
+ * or equal to operation ({@code <=}) to each lane.
*
* @param s the input scalar
* @return the mask result of testing if this vector is less than or equal
* to the broadcast of an input scalar
*/
@@ -672,12 +669,12 @@
public abstract VectorMask<Double> greaterThan(Vector<Double> v);
/**
* Tests if this vector is greater than the broadcast of an input scalar.
* <p>
- * This is a vector binary test operation where the primitive greater than
- * operation ({@code >}) is applied to lane elements.
+ * This is a lane-wise binary test operation which applies the primitive greater than
+ * operation ({@code >}) to each lane.
*
* @param s the input scalar
* @return the mask result of testing if this vector is greater than the
* broadcast of an input scalar
*/
@@ -688,12 +685,12 @@
/**
* Tests if this vector is greater than or equal to the broadcast of an
* input scalar.
* <p>
- * This is a vector binary test operation where the primitive greater than
- * or equal to operation ({@code >=}) is applied to lane elements.
+ * This is a lane-wise binary test operation which applies the primitive greater than
+ * or equal to operation ({@code >=}) to each lane.
*
* @param s the input scalar
* @return the mask result of testing if this vector is greater than or
* equal to the broadcast of an input scalar
*/
@@ -742,23 +739,23 @@
public abstract DoubleVector shiftER(int i);
/**
* Divides this vector by an input vector.
* <p>
- * This is a vector binary operation where the primitive division
- * operation ({@code /}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive division
+ * operation ({@code /}) to each lane.
*
* @param v the input vector
* @return the result of dividing this vector by the input vector
*/
public abstract DoubleVector div(Vector<Double> v);
/**
* Divides this vector by the broadcast of an input scalar.
* <p>
- * This is a vector binary operation where the primitive division
- * operation ({@code /}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive division
+ * operation ({@code /}) to each lane.
*
* @param s the input scalar
* @return the result of dividing this vector by the broadcast of an input
* scalar
*/
@@ -766,12 +763,12 @@
/**
* Divides this vector by an input vector, selecting lane elements
* controlled by a mask.
* <p>
- * This is a vector binary operation where the primitive division
- * operation ({@code /}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive division
+ * operation ({@code /}) to each lane.
*
* @param v the input vector
* @param m the mask controlling lane selection
* @return the result of dividing this vector by the input vector
*/
@@ -779,12 +776,12 @@
/**
* Divides this vector by the broadcast of an input scalar, selecting lane
* elements controlled by a mask.
* <p>
- * This is a vector binary operation where the primitive division
- * operation ({@code /}) is applied to lane elements.
+ * This is a lane-wise binary operation which applies the primitive division
+ * operation ({@code /}) to each lane.
*
* @param s the input scalar
* @param m the mask controlling lane selection
* @return the result of dividing this vector by the broadcast of an input
* scalar
@@ -792,23 +789,23 @@
public abstract DoubleVector div(double s, VectorMask<Double> m);
/**
* Calculates the square root of this vector.
* <p>
- * This is a vector unary operation where the {@link Math#sqrt} operation
- * is applied to lane elements.
+ * This is a lane-wise unary operation which applies the {@link Math#sqrt} operation
+ * to each lane.
*
* @return the square root of this vector
*/
public abstract DoubleVector sqrt();
/**
* Calculates the square root of this vector, selecting lane elements
* controlled by a mask.
* <p>
- * This is a vector unary operation where the {@link Math#sqrt} operation
- * is applied to lane elements.
+ * This is a lane-wise unary operation which applies the {@link Math#sqrt} operation
+ * to each lane.
*
* @param m the mask controlling lane selection
* @return the square root of this vector
*/
public DoubleVector sqrt(VectorMask<Double> m) {
@@ -816,12 +813,12 @@
}
/**
* Calculates the trigonometric tangent of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#tan} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#tan} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#tan}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#tan}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -847,12 +844,12 @@
}
/**
* Calculates the hyperbolic tangent of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#tanh} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#tanh} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#tanh}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#tanh}
* specifications. The computed result will be within 2.5 ulps of the
* exact result.
@@ -878,12 +875,12 @@
}
/**
* Calculates the trigonometric sine of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#sin} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#sin} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#sin}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#sin}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -909,12 +906,12 @@
}
/**
* Calculates the hyperbolic sine of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#sinh} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#sinh} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#sinh}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#sinh}
* specifications. The computed result will be within 2.5 ulps of the
* exact result.
@@ -940,12 +937,12 @@
}
/**
* Calculates the trigonometric cosine of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#cos} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#cos} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#cos}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#cos}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -971,12 +968,12 @@
}
/**
* Calculates the hyperbolic cosine of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#cosh} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#cosh} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#cosh}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#cosh}
* specifications. The computed result will be within 2.5 ulps of the
* exact result.
@@ -1002,12 +999,12 @@
}
/**
* Calculates the arc sine of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#asin} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#asin} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#asin}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#asin}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1033,12 +1030,12 @@
}
/**
* Calculates the arc cosine of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#acos} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#acos} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#acos}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#acos}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1064,12 +1061,12 @@
}
/**
* Calculates the arc tangent of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#atan} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#atan} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#atan}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#atan}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1095,12 +1092,12 @@
}
/**
* Calculates the arc tangent of this vector divided by an input vector.
* <p>
- * This is a vector binary operation with same semantic definition as
- * {@link Math#atan2} operation applied to lane elements.
+ * This is a lane-wise binary operation with same semantic definition as
+ * {@link Math#atan2} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#atan2}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#atan2}
* specifications. The computed result will be within 2 ulps of the
* exact result.
@@ -1114,12 +1111,12 @@
/**
* Calculates the arc tangent of this vector divided by the broadcast of an
* an input scalar.
* <p>
- * This is a vector binary operation with same semantic definition as
- * {@link Math#atan2} operation applied to lane elements.
+ * This is a lane-wise binary operation with same semantic definition as
+ * {@link Math#atan2} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#atan2}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#atan2}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1158,12 +1155,12 @@
public abstract DoubleVector atan2(double s, VectorMask<Double> m);
/**
* Calculates the cube root of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#cbrt} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#cbrt} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#cbrt}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#cbrt}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1189,12 +1186,12 @@
}
/**
* Calculates the natural logarithm of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#log} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#log} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#log}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#log}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1220,12 +1217,12 @@
}
/**
* Calculates the base 10 logarithm of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#log10} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#log10} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#log10}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#log10}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1252,12 +1249,12 @@
/**
* Calculates the natural logarithm of the sum of this vector and the
* broadcast of {@code 1}.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#log1p} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#log1p} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#log1p}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#log1p}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1285,12 +1282,12 @@
}
/**
* Calculates this vector raised to the power of an input vector.
* <p>
- * This is a vector binary operation with same semantic definition as
- * {@link Math#pow} operation applied to lane elements.
+ * This is a lane-wise binary operation with same semantic definition as
+ * {@link Math#pow} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#pow}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#pow}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1304,12 +1301,12 @@
/**
* Calculates this vector raised to the power of the broadcast of an input
* scalar.
* <p>
- * This is a vector binary operation with same semantic definition as
- * {@link Math#pow} operation applied to lane elements.
+ * This is a lane-wise binary operation with same semantic definition as
+ * {@link Math#pow} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#pow}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#pow}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1351,12 +1348,12 @@
/**
* Calculates the broadcast of Euler's number {@code e} raised to the power
* of this vector.
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#exp} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#exp} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#exp}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#exp}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1387,15 +1384,15 @@
* Calculates the broadcast of Euler's number {@code e} raised to the power
* of this vector minus the broadcast of {@code -1}.
* More specifically as if the following (ignoring any differences in
* numerical accuracy):
* <pre>{@code
- * this.exp().sub(this.species().broadcast(1))
+ * this.exp().sub(EVector.broadcast(this.species(), 1))
* }</pre>
* <p>
- * This is a vector unary operation with same semantic definition as
- * {@link Math#expm1} operation applied to lane elements.
+ * This is a lane-wise unary operation with same semantic definition as
+ * {@link Math#expm1} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#expm1}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#expm1}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1412,11 +1409,11 @@
* of this vector minus the broadcast of {@code -1}, selecting lane elements
* controlled by a mask
* More specifically as if the following (ignoring any differences in
* numerical accuracy):
* <pre>{@code
- * this.exp(m).sub(this.species().broadcast(1), m)
+ * this.exp(m).sub(EVector.broadcast(this.species(), 1), m)
* }</pre>
* <p>
* Semantics for rounding, monotonicity, and special cases are
* described in {@link DoubleVector#expm1}
*
@@ -1435,12 +1432,12 @@
* numerical accuracy):
* <pre>{@code
* this.mul(v1).add(v2)
* }</pre>
* <p>
- * This is a vector ternary operation where the {@link Math#fma} operation
- * is applied to lane elements.
+ * This is a lane-wise ternary operation which applies the {@link Math#fma} operation
+ * to each lane.
*
* @param v1 the first input vector
* @param v2 the second input vector
* @return the product of this vector and the first input vector summed with
* the second input vector
@@ -1450,15 +1447,15 @@
/**
* Calculates the product of this vector and the broadcast of a first input
* scalar summed with the broadcast of a second input scalar.
* More specifically as if the following:
* <pre>{@code
- * this.fma(this.species().broadcast(s1), this.species().broadcast(s2))
+ * this.fma(EVector.broadcast(this.species(), s1), EVector.broadcast(this.species(), s2))
* }</pre>
* <p>
- * This is a vector ternary operation where the {@link Math#fma} operation
- * is applied to lane elements.
+ * This is a lane-wise ternary operation which applies the {@link Math#fma} operation
+ * to each lane.
*
* @param s1 the first input scalar
* @param s2 the second input scalar
* @return the product of this vector and the broadcast of a first input
* scalar summed with the broadcast of a second input scalar
@@ -1472,12 +1469,12 @@
* numerical accuracy):
* <pre>{@code
* this.mul(v1, m).add(v2, m)
* }</pre>
* <p>
- * This is a vector ternary operation where the {@link Math#fma} operation
- * is applied to lane elements.
+ * This is a lane-wise ternary operation which applies the {@link Math#fma} operation
+ * to each lane.
*
* @param v1 the first input vector
* @param v2 the second input vector
* @param m the mask controlling lane selection
* @return the product of this vector and the first input vector summed with
@@ -1491,15 +1488,15 @@
* Calculates the product of this vector and the broadcast of a first input
* scalar summed with the broadcast of a second input scalar, selecting lane
* elements controlled by a mask
* More specifically as if the following:
* <pre>{@code
- * this.fma(this.species().broadcast(s1), this.species().broadcast(s2), m)
+ * this.fma(EVector.broadcast(this.species(), s1), EVector.broadcast(this.species(), s2), m)
* }</pre>
* <p>
- * This is a vector ternary operation where the {@link Math#fma} operation
- * is applied to lane elements.
+ * This is a lane-wise ternary operation which applies the {@link Math#fma} operation
+ * to each lane.
*
* @param s1 the first input scalar
* @param s2 the second input scalar
* @param m the mask controlling lane selection
* @return the product of this vector and the broadcast of a first input
@@ -1514,12 +1511,12 @@
* numerical accuracy):
* <pre>{@code
* this.mul(this).add(v.mul(v)).sqrt()
* }</pre>
* <p>
- * This is a vector binary operation with same semantic definition as
- * {@link Math#hypot} operation applied to lane elements.
+ * This is a lane-wise binary operation with same semantic definition as
+ * {@link Math#hypot} operation applied to each lane.
* The implementation is not required to return same
* results as {@link Math#hypot}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#hypot}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1536,15 +1533,15 @@
* Calculates square root of the sum of the squares of this vector and the
* broadcast of an input scalar.
* More specifically as if the following (ignoring any differences in
* numerical accuracy):
* <pre>{@code
- * this.mul(this).add(this.species().broadcast(v * v)).sqrt()
+ * this.mul(this).add(EVector.broadcast(this.species(), s * s)).sqrt()
* }</pre>
* <p>
- * This is a vector binary operation with same semantic definition as
- * {@link Math#hypot} operation applied to lane elements.
+ * This is a lane-wise binary operation with same semantic definition as
+ * {@link Math#hypot} operation applied to each.
* The implementation is not required to return same
* results as {@link Math#hypot}, but adheres to rounding, monotonicity,
* and special case semantics as defined in the {@link Math#hypot}
* specifications. The computed result will be within 1 ulp of the
* exact result.
@@ -1581,11 +1578,11 @@
* broadcast of an input scalar, selecting lane elements controlled by a
* mask.
* More specifically as if the following (ignoring any differences in
* numerical accuracy):
* <pre>{@code
- * this.mul(this, m).add(this.species().broadcast(v * v), m).sqrt(m)
+ * this.mul(this, m).add(EVector.broadcast(this.species(), s * s), m).sqrt(m)
* }</pre>
* <p>
* Semantics for rounding, monotonicity, and special cases are
* described in {@link DoubleVector#hypot}
*
@@ -1612,12 +1609,12 @@
// Type specific horizontal reductions
/**
* Adds all lane elements of this vector.
* <p>
- * This is a vector reduction operation where the addition
- * operation ({@code +}) is applied to lane elements,
+ * This is a cross-lane reduction operation which applies the addition
+ * operation ({@code +}) to lane elements,
* and the identity value is {@code 0.0}.
*
* <p>The value of a floating-point sum is a function both of the input values as well
* as the order of addition operations. The order of addition operations of this method
* is intentionally not defined to allow for JVM to generate optimal machine
@@ -1633,12 +1630,12 @@
/**
* Adds all lane elements of this vector, selecting lane elements
* controlled by a mask.
* <p>
- * This is a vector reduction operation where the addition
- * operation ({@code +}) is applied to lane elements,
+ * This is a cross-lane reduction operation which applies the addition
+ * operation ({@code +}) to lane elements,
* and the identity value is {@code 0.0}.
*
* <p>The value of a floating-point sum is a function both of the input values as well
* as the order of addition operations. The order of addition operations of this method
* is intentionally not defined to allow for JVM to generate optimal machine
@@ -1654,12 +1651,12 @@
public abstract double addAll(VectorMask<Double> m);
/**
* Multiplies all lane elements of this vector.
* <p>
- * This is a vector reduction operation where the
- * multiplication operation ({@code *}) is applied to lane elements,
+ * This is a cross-lane reduction operation which applies the
+ * multiplication operation ({@code *}) to lane elements,
* and the identity value is {@code 1.0}.
*
* <p>The order of multiplication operations of this method
* is intentionally not defined to allow for JVM to generate optimal machine
* code for the underlying platform at runtime. If the platform supports a vector
@@ -1674,12 +1671,12 @@
/**
* Multiplies all lane elements of this vector, selecting lane elements
* controlled by a mask.
* <p>
- * This is a vector reduction operation where the
- * multiplication operation ({@code *}) is applied to lane elements,
+ * This is a cross-lane reduction operation which applies the
+ * multiplication operation ({@code *}) to lane elements,
* and the identity value is {@code 1.0}.
*
* <p>The order of multiplication operations of this method
* is intentionally not defined to allow for JVM to generate optimal machine
* code for the underlying platform at runtime. If the platform supports a vector
@@ -1694,12 +1691,12 @@
public abstract double mulAll(VectorMask<Double> m);
/**
* 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,
+ * This is an associative cross-lane reduction operation which applies the operation
+ * {@code (a, b) -> Math.min(a, b)} to lane elements,
* and the identity value is
* {@link Double#POSITIVE_INFINITY}.
*
* @return the minimum lane element of this vector
*/
@@ -1707,12 +1704,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,
+ * This is an associative cross-lane reduction operation which applies the operation
+ * {@code (a, b) -> Math.min(a, b)} to lane elements,
* and the identity value is
* {@link Double#POSITIVE_INFINITY}.
*
* @param m the mask controlling lane selection
* @return the minimum lane element of this vector
@@ -1720,12 +1717,12 @@
public abstract double minAll(VectorMask<Double> m);
/**
* 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,
+ * This is an associative cross-lane reduction operation which applies the operation
+ * {@code (a, b) -> Math.max(a, b)} to lane elements,
* and the identity value is
* {@link Double#NEGATIVE_INFINITY}.
*
* @return the maximum lane element of this vector
*/
@@ -1733,12 +1730,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,
+ * This is an associative cross-lane reduction operation which applies the operation
+ * {@code (a, b) -> Math.max(a, b)} to lane elements,
* and the identity value is
* {@link Double#NEGATIVE_INFINITY}.
*
* @param m the mask controlling lane selection
* @return the maximum lane element of this vector
@@ -1754,11 +1751,11 @@
* @param i the lane index
* @return the lane element at lane index {@code i}
* @throws IllegalArgumentException if the index is is out of range
* ({@code < 0 || >= length()})
*/
- public abstract double get(int i);
+ public abstract double lane(int i);
/**
* Replaces the lane element of this vector at lane index {@code i} with
* value {@code e}.
* <p>
@@ -1801,79 +1798,79 @@
/**
* Stores this vector into an array starting at offset.
* <p>
* For each vector lane, where {@code N} is the vector lane index,
* the lane element at index {@code N} is stored into the array at index
- * {@code i + N}.
+ * {@code offset + N}.
*
* @param a the array
- * @param i the offset into the array
- * @throws IndexOutOfBoundsException if {@code i < 0}, or
- * {@code i > a.length - this.length()}
+ * @param offset the offset into the array
+ * @throws IndexOutOfBoundsException if {@code offset < 0}, or
+ * {@code offset > a.length - this.length()}
*/
- public abstract void intoArray(double[] a, int i);
+ public abstract void intoArray(double[] a, int offset);
/**
* Stores this vector into an array starting at offset and using a mask.
* <p>
* For each vector lane, where {@code N} is the vector lane index,
* if the mask lane at index {@code N} is set then the lane element at
- * index {@code N} is stored into the array index {@code i + N}.
+ * index {@code N} is stored into the array index {@code offset + N}.
*
* @param a the array
- * @param i the offset into the array
+ * @param offset the offset into the array
* @param m the mask
- * @throws IndexOutOfBoundsException if {@code i < 0}, or
+ * @throws IndexOutOfBoundsException if {@code offset < 0}, or
* for any vector lane index {@code N} where the mask at lane {@code N}
- * is set {@code i >= a.length - N}
+ * is set {@code offset >= a.length - N}
*/
- public abstract void intoArray(double[] a, int i, VectorMask<Double> m);
+ public abstract void intoArray(double[] a, int offset, VectorMask<Double> m);
/**
* Stores this vector into an array using indexes obtained from an index
* map.
* <p>
* For each vector lane, where {@code N} is the vector lane index, the
* lane element at index {@code N} is stored into the array at index
- * {@code i + indexMap[j + N]}.
+ * {@code a_offset + indexMap[i_offset + N]}.
*
* @param a the array
- * @param i the offset into the array, may be negative if relative
+ * @param a_offset 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
- * @param j the offset into the index map
- * @throws IndexOutOfBoundsException if {@code j < 0}, or
- * {@code j > indexMap.length - this.length()},
+ * @param i_offset the offset into the index map
+ * @throws IndexOutOfBoundsException if {@code i_offset < 0}, or
+ * {@code i_offset > indexMap.length - this.length()},
* or for any vector lane index {@code N} the result of
- * {@code i + indexMap[j + N]} is {@code < 0} or {@code >= a.length}
+ * {@code a_offset + indexMap[i_offset + N]} is {@code < 0} or {@code >= a.length}
*/
- public abstract void intoArray(double[] a, int i, int[] indexMap, int j);
+ public abstract void intoArray(double[] a, int a_offset, int[] indexMap, int i_offset);
/**
* Stores this vector into an array using indexes obtained from an index
* map and using a mask.
* <p>
* For each vector lane, where {@code N} is the vector lane index,
* if the mask lane at index {@code N} is set then the lane element at
* index {@code N} is stored into the array at index
- * {@code i + indexMap[j + N]}.
+ * {@code a_offset + indexMap[i_offset + N]}.
*
* @param a the array
- * @param i the offset into the array, may be negative if relative
+ * @param a_offset 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
+ * @param i_offset the offset into the index map
* @throws IndexOutOfBoundsException if {@code j < 0}, or
- * {@code j > indexMap.length - this.length()},
+ * {@code i_offset > indexMap.length - this.length()},
* or for any vector lane index {@code N} where the mask at lane
- * {@code N} is set the result of {@code i + indexMap[j + N]} is
+ * {@code N} is set the result of {@code a_offset + indexMap[i_offset + N]} is
* {@code < 0} or {@code >= a.length}
*/
- public abstract void intoArray(double[] a, int i, VectorMask<Double> m, int[] indexMap, int j);
+ public abstract void intoArray(double[] a, int a_offset, VectorMask<Double> m, int[] indexMap, int i_offset);
// Species
@Override
public abstract VectorSpecies<Double> species();
< prev index next >