Module jdk.incubator.vector
Package jdk.incubator.vector

Class FloatVector

  • public abstract class FloatVector
extends Vector<Float>
    A specialized Vector representing an ordered immutable sequence of float values.

    • Method Detail

      • zero

        public static FloatVector zero​(VectorSpecies<Float> species)
        Returns a vector where all lane elements are set to the default primitive value.
        Parameters:
        species - species of desired vector
        Returns:
        a zero vector of given species

      • fromByteArray

        public static FloatVector fromByteArray​(VectorSpecies<Float> species,
                                        byte[] a,
                                        int offset)
        Loads a vector from a byte array starting at an offset.

        Bytes are composed into primitive lane elements according to the native byte order of the underlying platform

        This method behaves as if it returns the result of calling the byte buffer, offset, and mask accepting method as follows: 

        
 return fromByteBuffer(species, ByteBuffer.wrap(a), offset, VectorMask.allTrue());
        Parameters:
        species - species of desired vector
        a - the byte array
        offset - the offset into the array
        Returns:
        a vector loaded from a byte array
        Throws:
        IndexOutOfBoundsException - if i < 0 or offset > a.length - (species.length() * species.elementSize() / Byte.SIZE)

      • fromByteArray

        public static FloatVector fromByteArray​(VectorSpecies<Float> species,
                                        byte[] a,
                                        int offset,
                                        VectorMask<Float> m)
        Loads a vector from a byte array starting at an offset and using a mask.

        Bytes are composed into primitive lane elements according to the native byte order of the underlying platform.

        This method behaves as if it returns the result of calling the byte buffer, offset, and mask accepting method as follows: 

        
 return fromByteBuffer(species, ByteBuffer.wrap(a), offset, m);
        Parameters:
        species - species of desired vector
        a - the byte array
        offset - the offset into the array
        m - the mask
        Returns:
        a vector loaded from a byte array
        Throws:
        IndexOutOfBoundsException - if offset < 0 or for any vector lane index N where the mask at lane N is set offset >= a.length - (N * species.elementSize() / Byte.SIZE)

      • fromArray

        public static FloatVector fromArray​(VectorSpecies<Float> species,
                                    float[] a,
                                    int offset)
        Loads a vector from an array starting at offset.

        For each vector lane, where N is the vector lane index, the array element at index offset + N is placed into the resulting vector at lane index N.

        Parameters:
        species - species of desired vector
        a - the array
        offset - the offset into the array
        Returns:
        the vector loaded from an array
        Throws:
        IndexOutOfBoundsException - if offset < 0, or offset > a.length - species.length()

      • fromArray

        public static FloatVector fromArray​(VectorSpecies<Float> species,
                                    float[] a,
                                    int offset,
                                    VectorMask<Float> m)
        Loads a vector from an array starting at offset and using a mask.

        For each vector lane, where N is the vector lane index, if the mask lane at index N is set then the array element at index offset + N is placed into the resulting vector at lane index N, otherwise the default element value is placed into the resulting vector at lane index N.

        Parameters:
        species - species of desired vector
        a - the array
        offset - the offset into the array
        m - the mask
        Returns:
        the vector loaded from an array
        Throws:
        IndexOutOfBoundsException - if offset < 0, or for any vector lane index N where the mask at lane N is set offset > a.length - N

      • fromArray

        public static FloatVector fromArray​(VectorSpecies<Float> species,
                                    float[] a,
                                    int a_offset,
                                    int[] indexMap,
                                    int i_offset)
        Loads a vector from an array using indexes obtained from an index map.

        For each vector lane, where N is the vector lane index, the array element at index a_offset + indexMap[i_offset + N] is placed into the resulting vector at lane index N.

        Parameters:
        species - species of desired vector
        a - the array
        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
        indexMap - the index map
        i_offset - the offset into the index map
        Returns:
        the vector loaded from an array
        Throws:
        IndexOutOfBoundsException - if i_offset < 0, or i_offset > indexMap.length - species.length(), or for any vector lane index N the result of a_offset + indexMap[i_offset + N] is < 0 or >= a.length

      • fromArray

        public static FloatVector fromArray​(VectorSpecies<Float> species,
                                    float[] a,
                                    int a_offset,
                                    VectorMask<Float> m,
                                    int[] indexMap,
                                    int i_offset)
        Loads a vector from an array using indexes obtained from an index map and using a mask.

        For each vector lane, where N is the vector lane index, if the mask lane at index N is set then the array element at index a_offset + indexMap[i_offset + N] is placed into the resulting vector at lane index N.

        Parameters:
        species - species of desired vector
        a - the array
        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
        m - the mask
        indexMap - the index map
        i_offset - the offset into the index map
        Returns:
        the vector loaded from an array
        Throws:
        IndexOutOfBoundsException - if i_offset < 0, or i_offset > indexMap.length - species.length(), or for any vector lane index N where the mask at lane N is set the result of a_offset + indexMap[i_offset + N] is < 0 or >= a.length

      • fromByteBuffer

        public static FloatVector fromByteBuffer​(VectorSpecies<Float> species,
                                         ByteBuffer bb,
                                         int offset)
        Loads a vector from a byte buffer starting at an offset into the byte buffer.

        Bytes are composed into primitive lane elements according to the native byte order of the underlying platform.

        This method behaves as if it returns the result of calling the byte buffer, offset, and mask accepting fromByteBuffer(VectorSpecies, ByteBuffer, int, VectorMask) method} as follows: 

        
   return fromByteBuffer(b, offset, VectorMask.allTrue())
        Parameters:
        species - species of desired vector
        bb - the byte buffer
        offset - the offset into the byte buffer
        Returns:
        a vector loaded from a byte buffer
        Throws:
        IndexOutOfBoundsException - if the offset is < 0, or > b.limit(), or if there are fewer than species.length() * species.elementSize() / Byte.SIZE bytes remaining in the byte buffer from the given offset

      • fromByteBuffer

        public static FloatVector fromByteBuffer​(VectorSpecies<Float> species,
                                         ByteBuffer bb,
                                         int offset,
                                         VectorMask<Float> m)
        Loads a vector from a byte buffer starting at an offset into the byte buffer and using a mask.

        This method behaves as if the byte buffer is viewed as a primitive 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 EBuffer is the primitive buffer type, e is the primitive element type, and ESpecies is the primitive species for e: 

        
 EBuffer eb = b.duplicate().
     order(ByteOrder.nativeOrder()).position(offset).
     asEBuffer();
 e[] es = new e[species.length()];
 for (int n = 0; n < t.length; n++) {
     if (m.isSet(n))
         es[n] = eb.get(n);
 }
 EVector r = EVector.fromArray(es, 0, m);
        Parameters:
        species - species of desired vector
        bb - the byte buffer
        offset - the offset into the byte buffer
        m - the mask
        Returns:
        a vector loaded from a byte buffer
        Throws:
        IndexOutOfBoundsException - if the offset is < 0, or > b.limit(), for any vector lane index N where the mask at lane N is set offset >= b.limit() - (N * species.elementSize() / Byte.SIZE)

      • broadcast

        public static FloatVector broadcast​(VectorSpecies<Float> species,
                                    float e)
        Returns a vector where all lane elements are set to the primitive value e.
        Parameters:
        species - species of the desired vector
        e - the value
        Returns:
        a vector of vector where all lane elements are set to the primitive value e

      • scalars

        public static FloatVector scalars​(VectorSpecies<Float> species,
                                  float... es)
        Returns a vector where each lane element is set to given primitive values.

        For each vector lane, where N is the vector lane index, the the primitive value at index N is placed into the resulting vector at lane index N.

        Parameters:
        species - species of the desired vector
        es - the given primitive values
        Returns:
        a vector where each lane element is set to given primitive values
        Throws:
        IndexOutOfBoundsException - if es.length < species.length()

      • single

        public static final FloatVector single​(VectorSpecies<Float> species,
                                       float e)
        Returns a vector where the first lane element is set to the primtive value e, all other lane elements are set to the default value.
        Parameters:
        species - species of the desired vector
        e - the value
        Returns:
        a vector where the first lane element is set to the primitive value e

      • random

        public static FloatVector random​(VectorSpecies<Float> species)
        Returns a vector where each lane element is set to a randomly generated primitive value. The semantics are equivalent to calling ThreadLocalRandom.nextFloat()
        Parameters:
        species - species of the desired vector
        Returns:
        a vector where each lane elements is set to a randomly generated primitive value

      • add

        public abstract FloatVector add​(float s)
        Adds this vector to the broadcast of an input scalar.

        This is a lane-wise binary operation which applies the primitive addition operation (+) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the result of adding this vector to the broadcast of an input scalar

      • add

        public abstract FloatVector add​(float s,
                                VectorMask<Float> m)
        Adds this vector to broadcast of an input scalar, selecting lane elements controlled by a mask.

        This is a lane-wise binary operation which applies the primitive addition operation (+) to each lane.

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        the result of adding this vector to the broadcast of an input scalar

      • sub

        public abstract FloatVector sub​(float s)
        Subtracts the broadcast of an input scalar from this vector.

        This is a lane-wise binary operation which applies the primitive subtraction operation (-) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the result of subtracting the broadcast of an input scalar from this vector

      • sub

        public abstract FloatVector sub​(float s,
                                VectorMask<Float> m)
        Subtracts the broadcast of an input scalar from this vector, selecting lane elements controlled by a mask.

        This is a lane-wise binary operation which applies the primitive subtraction operation (-) to each lane.

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        the result of subtracting the broadcast of an input scalar from this vector

      • mul

        public abstract FloatVector mul​(float s)
        Multiplies this vector with the broadcast of an input scalar.

        This is a lane-wise binary operation which applies the primitive multiplication operation (*) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the result of multiplying this vector with the broadcast of an input scalar

      • mul

        public abstract FloatVector mul​(float s,
                                VectorMask<Float> m)
        Multiplies this vector with the broadcast of an input scalar, selecting lane elements controlled by a mask.

        This is a lane-wise binary operation which applies the primitive multiplication operation (*) to each lane.

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        the result of multiplying this vector with the broadcast of an input scalar

      • min

        public abstract FloatVector min​(float s)
        Returns the minimum of this vector and the broadcast of an input scalar.

        This is a lane-wise binary operation which applies the operation (a, b) -> Math.min(a, b) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the minimum of this vector and the broadcast of an input scalar

      • max

        public abstract FloatVector max​(float s)
        Returns the maximum of this vector and the broadcast of an input scalar.

        This is a lane-wise binary operation which applies the operation (a, b) -> Math.max(a, b) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the maximum of this vector and the broadcast of an input scalar

      • equal

        public abstract VectorMask<Float> equal​(float s)
        Tests if this vector is equal to the broadcast of an input scalar.

        This is a lane-wise binary test operation which applies the primitive equals operation (==) each lane.

        Parameters:
        s - the input scalar
        Returns:
        the result mask of testing if this vector is equal to the broadcast of an input scalar

      • notEqual

        public abstract VectorMask<Float> notEqual​(float s)
        Tests if this vector is not equal to the broadcast of an input scalar.

        This is a lane-wise binary test operation which applies the primitive not equals operation (!=) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the result mask of testing if this vector is not equal to the broadcast of an input scalar

      • lessThan

        public abstract VectorMask<Float> lessThan​(float s)
        Tests if this vector is less than the broadcast of an input scalar.

        This is a lane-wise binary test operation which applies the primitive less than operation (<) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the mask result of testing if this vector is less than the broadcast of an input scalar

      • lessThanEq

        public abstract VectorMask<Float> lessThanEq​(float s)
        Tests if this vector is less or equal to the broadcast of an input scalar.

        This is a lane-wise binary test operation which applies the primitive less than or equal to operation (<=) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the mask result of testing if this vector is less than or equal to the broadcast of an input scalar

      • greaterThan

        public abstract VectorMask<Float> greaterThan​(float s)
        Tests if this vector is greater than the broadcast of an input scalar.

        This is a lane-wise binary test operation which applies the primitive greater than operation (>) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the mask result of testing if this vector is greater than the broadcast of an input scalar

      • greaterThanEq

        public abstract VectorMask<Float> greaterThanEq​(float s)
        Tests if this vector is greater than or equal to the broadcast of an input scalar.

        This is a lane-wise binary test operation which applies the primitive greater than or equal to operation (>=) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the mask result of testing if this vector is greater than or equal to the broadcast of an input scalar

      • blend

        public abstract FloatVector blend​(float s,
                                  VectorMask<Float> m)
        Blends the lane elements of this vector with those of the broadcast of an input scalar, selecting lanes controlled by a mask.

        For each lane of the mask, at lane index N, if the mask lane is set then the lane element at N from the input vector is selected and placed into the resulting vector at N, otherwise the the lane element at N from this input vector is selected and placed into the resulting vector at N.

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        the result of blending the lane elements of this vector with those of the broadcast of an input scalar

      • div

        public abstract FloatVector div​(Vector<Float> v)
        Divides this vector by an input vector.

        This is a lane-wise binary operation which applies the primitive division operation (/) to each lane.

        Parameters:
        v - the input vector
        Returns:
        the result of dividing this vector by the input vector

      • div

        public abstract FloatVector div​(float s)
        Divides this vector by the broadcast of an input scalar.

        This is a lane-wise binary operation which applies the primitive division operation (/) to each lane.

        Parameters:
        s - the input scalar
        Returns:
        the result of dividing this vector by the broadcast of an input scalar

      • div

        public abstract FloatVector div​(Vector<Float> v,
                                VectorMask<Float> m)
        Divides this vector by an input vector, selecting lane elements controlled by a mask.

        This is a lane-wise binary operation which applies the primitive division operation (/) to each lane.

        Parameters:
        v - the input vector
        m - the mask controlling lane selection
        Returns:
        the result of dividing this vector by the input vector

      • div

        public abstract FloatVector div​(float s,
                                VectorMask<Float> m)
        Divides this vector by the broadcast of an input scalar, selecting lane elements controlled by a mask.

        This is a lane-wise binary operation which applies the primitive division operation (/) to each lane.

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        the result of dividing this vector by the broadcast of an input scalar

      • sqrt

        public abstract FloatVector sqrt()
        Calculates the square root of this vector.

        This is a lane-wise unary operation which applies the Math.sqrt(double) operation to each lane.

        Returns:
        the square root of this vector

      • sqrt

        public FloatVector sqrt​(VectorMask<Float> m)
        Calculates the square root of this vector, selecting lane elements controlled by a mask.

        This is a lane-wise unary operation which applies the Math.sqrt(double) operation to each lane.

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the square root of this vector

      • tan

        public FloatVector tan()
        Calculates the trigonometric tangent of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.tan(double) operation applied to each lane. The implementation is not required to return same results as Math.tan(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.tan(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the tangent of this vector

      • tan

        public FloatVector tan​(VectorMask<Float> m)
        Calculates the trigonometric tangent of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in tan()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the tangent of this vector

      • tanh

        public FloatVector tanh()
        Calculates the hyperbolic tangent of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.tanh(double) operation applied to each lane. The implementation is not required to return same results as Math.tanh(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.tanh(double) specifications. The computed result will be within 2.5 ulps of the exact result.

        Returns:
        the hyperbolic tangent of this vector

      • tanh

        public FloatVector tanh​(VectorMask<Float> m)
        Calculates the hyperbolic tangent of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in tanh()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the hyperbolic tangent of this vector

      • sin

        public FloatVector sin()
        Calculates the trigonometric sine of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.sin(double) operation applied to each lane. The implementation is not required to return same results as Math.sin(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.sin(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the sine of this vector

      • sin

        public FloatVector sin​(VectorMask<Float> m)
        Calculates the trigonometric sine of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in sin()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the sine of this vector

      • sinh

        public FloatVector sinh()
        Calculates the hyperbolic sine of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.sinh(double) operation applied to each lane. The implementation is not required to return same results as Math.sinh(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.sinh(double) specifications. The computed result will be within 2.5 ulps of the exact result.

        Returns:
        the hyperbolic sine of this vector

      • sinh

        public FloatVector sinh​(VectorMask<Float> m)
        Calculates the hyperbolic sine of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in sinh()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the hyperbolic sine of this vector

      • cos

        public FloatVector cos()
        Calculates the trigonometric cosine of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.cos(double) operation applied to each lane. The implementation is not required to return same results as Math.cos(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.cos(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the cosine of this vector

      • cos

        public FloatVector cos​(VectorMask<Float> m)
        Calculates the trigonometric cosine of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in cos()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the cosine of this vector

      • cosh

        public FloatVector cosh()
        Calculates the hyperbolic cosine of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.cosh(double) operation applied to each lane. The implementation is not required to return same results as Math.cosh(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.cosh(double) specifications. The computed result will be within 2.5 ulps of the exact result.

        Returns:
        the hyperbolic cosine of this vector

      • cosh

        public FloatVector cosh​(VectorMask<Float> m)
        Calculates the hyperbolic cosine of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in cosh()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the hyperbolic cosine of this vector

      • asin

        public FloatVector asin()
        Calculates the arc sine of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.asin(double) operation applied to each lane. The implementation is not required to return same results as Math.asin(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.asin(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the arc sine of this vector

      • asin

        public FloatVector asin​(VectorMask<Float> m)
        Calculates the arc sine of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in asin()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the arc sine of this vector

      • acos

        public FloatVector acos()
        Calculates the arc cosine of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.acos(double) operation applied to each lane. The implementation is not required to return same results as Math.acos(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.acos(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the arc cosine of this vector

      • acos

        public FloatVector acos​(VectorMask<Float> m)
        Calculates the arc cosine of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in acos()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the arc cosine of this vector

      • atan

        public FloatVector atan()
        Calculates the arc tangent of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.atan(double) operation applied to each lane. The implementation is not required to return same results as Math.atan(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.atan(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the arc tangent of this vector

      • atan

        public FloatVector atan​(VectorMask<Float> m)
        Calculates the arc tangent of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in atan()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the arc tangent of this vector

      • atan2

        public FloatVector atan2​(Vector<Float> v)
        Calculates the arc tangent of this vector divided by an input vector.

        This is a lane-wise binary operation with same semantic definition as Math.atan2(double, double) operation applied to each lane. The implementation is not required to return same results as Math.atan2(double, double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.atan2(double, double) specifications. The computed result will be within 2 ulps of the exact result.

        Parameters:
        v - the input vector
        Returns:
        the arc tangent of this vector divided by the input vector

      • atan2

        public abstract FloatVector atan2​(float s)
        Calculates the arc tangent of this vector divided by the broadcast of an an input scalar.

        This is a lane-wise binary operation with same semantic definition as Math.atan2(double, double) operation applied to each lane. The implementation is not required to return same results as Math.atan2(double, double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.atan2(double, double) specifications. The computed result will be within 1 ulp of the exact result.

        Parameters:
        s - the input scalar
        Returns:
        the arc tangent of this vector over the input vector

      • atan2

        public FloatVector atan2​(Vector<Float> v,
                         VectorMask<Float> m)
        Calculates the arc tangent of this vector divided by an input vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in atan2(jdk.incubator.vector.Vector<java.lang.Float>)

        Parameters:
        v - the input vector
        m - the mask controlling lane selection
        Returns:
        the arc tangent of this vector divided by the input vector

      • atan2

        public abstract FloatVector atan2​(float s,
                                  VectorMask<Float> m)
        Calculates the arc tangent of this vector divided by the broadcast of an an input scalar, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in atan2(jdk.incubator.vector.Vector<java.lang.Float>)

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        the arc tangent of this vector over the input vector

      • cbrt

        public FloatVector cbrt()
        Calculates the cube root of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.cbrt(double) operation applied to each lane. The implementation is not required to return same results as Math.cbrt(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.cbrt(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the cube root of this vector

      • cbrt

        public FloatVector cbrt​(VectorMask<Float> m)
        Calculates the cube root of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in cbrt()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the cube root of this vector

      • log

        public FloatVector log()
        Calculates the natural logarithm of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.log(double) operation applied to each lane. The implementation is not required to return same results as Math.log(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.log(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the natural logarithm of this vector

      • log

        public FloatVector log​(VectorMask<Float> m)
        Calculates the natural logarithm of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in log()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the natural logarithm of this vector

      • log10

        public FloatVector log10()
        Calculates the base 10 logarithm of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.log10(double) operation applied to each lane. The implementation is not required to return same results as Math.log10(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.log10(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the base 10 logarithm of this vector

      • log10

        public FloatVector log10​(VectorMask<Float> m)
        Calculates the base 10 logarithm of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in log10()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the base 10 logarithm of this vector

      • log1p

        public FloatVector log1p()
        Calculates the natural logarithm of the sum of this vector and the broadcast of 1.

        This is a lane-wise unary operation with same semantic definition as Math.log1p(double) operation applied to each lane. The implementation is not required to return same results as Math.log1p(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.log1p(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the natural logarithm of the sum of this vector and the broadcast of 1

      • log1p

        public FloatVector log1p​(VectorMask<Float> m)
        Calculates the natural logarithm of the sum of this vector and the broadcast of 1, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in log1p()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the natural logarithm of the sum of this vector and the broadcast of 1

      • pow

        public FloatVector pow​(Vector<Float> v)
        Calculates this vector raised to the power of an input vector.

        This is a lane-wise binary operation with same semantic definition as Math.pow(double, double) operation applied to each lane. The implementation is not required to return same results as Math.pow(double, double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.pow(double, double) specifications. The computed result will be within 1 ulp of the exact result.

        Parameters:
        v - the input vector
        Returns:
        this vector raised to the power of an input vector

      • pow

        public abstract FloatVector pow​(float s)
        Calculates this vector raised to the power of the broadcast of an input scalar.

        This is a lane-wise binary operation with same semantic definition as Math.pow(double, double) operation applied to each lane. The implementation is not required to return same results as Math.pow(double, double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.pow(double, double) specifications. The computed result will be within 1 ulp of the exact result.

        Parameters:
        s - the input scalar
        Returns:
        this vector raised to the power of the broadcast of an input scalar.

      • pow

        public FloatVector pow​(Vector<Float> v,
                       VectorMask<Float> m)
        Calculates this vector raised to the power of an input vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in pow(jdk.incubator.vector.Vector<java.lang.Float>)

        Parameters:
        v - the input vector
        m - the mask controlling lane selection
        Returns:
        this vector raised to the power of an input vector

      • pow

        public abstract FloatVector pow​(float s,
                                VectorMask<Float> m)
        Calculates this vector raised to the power of the broadcast of an input scalar, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in pow(jdk.incubator.vector.Vector<java.lang.Float>)

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        this vector raised to the power of the broadcast of an input scalar.

      • exp

        public FloatVector exp()
        Calculates the broadcast of Euler's number e raised to the power of this vector.

        This is a lane-wise unary operation with same semantic definition as Math.exp(double) operation applied to each lane. The implementation is not required to return same results as Math.exp(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.exp(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the broadcast of Euler's number e raised to the power of this vector

      • exp

        public FloatVector exp​(VectorMask<Float> m)
        Calculates the broadcast of Euler's number e raised to the power of this vector, selecting lane elements controlled by a mask.

        Semantics for rounding, monotonicity, and special cases are described in exp()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the broadcast of Euler's number e raised to the power of this vector

      • expm1

        public FloatVector expm1()
        Calculates the broadcast of Euler's number e raised to the power of this vector minus the broadcast of -1. More specifically as if the following (ignoring any differences in numerical accuracy): 
        
   this.exp().sub(EVector.broadcast(this.species(), 1))

        This is a lane-wise unary operation with same semantic definition as Math.expm1(double) operation applied to each lane. The implementation is not required to return same results as Math.expm1(double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.expm1(double) specifications. The computed result will be within 1 ulp of the exact result.

        Returns:
        the broadcast of Euler's number e raised to the power of this vector minus the broadcast of -1

      • expm1

        public FloatVector expm1​(VectorMask<Float> m)
        Calculates the broadcast of Euler's number e raised to the power of this vector minus the broadcast of -1, selecting lane elements controlled by a mask More specifically as if the following (ignoring any differences in numerical accuracy): 
        
   this.exp(m).sub(EVector.broadcast(this.species(), 1), m)

        Semantics for rounding, monotonicity, and special cases are described in expm1()

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the broadcast of Euler's number e raised to the power of this vector minus the broadcast of -1

      • fma

        public abstract FloatVector fma​(Vector<Float> v1,
                                Vector<Float> v2)
        Calculates the product of this vector and a first input vector summed with a second input vector. More specifically as if the following (ignoring any differences in numerical accuracy): 
        
   this.mul(v1).add(v2)

        This is a lane-wise ternary operation which applies the Math.fma(double, double, double) operation to each lane.

        Parameters:
        v1 - the first input vector
        v2 - the second input vector
        Returns:
        the product of this vector and the first input vector summed with the second input vector

      • fma

        public abstract FloatVector fma​(float s1,
                                float s2)
        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: 
        
   this.fma(EVector.broadcast(this.species(), s1), EVector.broadcast(this.species(), s2))

        This is a lane-wise ternary operation which applies the Math.fma(double, double, double) operation to each lane.

        Parameters:
        s1 - the first input scalar
        s2 - the second input scalar
        Returns:
        the product of this vector and the broadcast of a first input scalar summed with the broadcast of a second input scalar

      • fma

        public FloatVector fma​(Vector<Float> v1,
                       Vector<Float> v2,
                       VectorMask<Float> m)
        Calculates the product of this vector and a first input vector summed with a second input vector, selecting lane elements controlled by a mask. More specifically as if the following (ignoring any differences in numerical accuracy): 
        
   this.mul(v1, m).add(v2, m)

        This is a lane-wise ternary operation which applies the Math.fma(double, double, double) operation to each lane.

        Parameters:
        v1 - the first input vector
        v2 - the second input vector
        m - the mask controlling lane selection
        Returns:
        the product of this vector and the first input vector summed with the second input vector

      • fma

        public abstract FloatVector fma​(float s1,
                                float s2,
                                VectorMask<Float> m)
        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: 
        
   this.fma(EVector.broadcast(this.species(), s1), EVector.broadcast(this.species(), s2), m)

        This is a lane-wise ternary operation which applies the Math.fma(double, double, double) operation to each lane.

        Parameters:
        s1 - the first input scalar
        s2 - the second input scalar
        m - the mask controlling lane selection
        Returns:
        the product of this vector and the broadcast of a first input scalar summed with the broadcast of a second input scalar

      • hypot

        public FloatVector hypot​(Vector<Float> v)
        Calculates square root of the sum of the squares of this vector and an input vector. More specifically as if the following (ignoring any differences in numerical accuracy): 
        
   this.mul(this).add(v.mul(v)).sqrt()

        This is a lane-wise binary operation with same semantic definition as Math.hypot(double, double) operation applied to each lane. The implementation is not required to return same results as Math.hypot(double, double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.hypot(double, double) specifications. The computed result will be within 1 ulp of the exact result.

        Parameters:
        v - the input vector
        Returns:
        square root of the sum of the squares of this vector and an input vector

      • hypot

        public abstract FloatVector hypot​(float s)
        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): 
        
   this.mul(this).add(EVector.broadcast(this.species(), s * s)).sqrt()

        This is a lane-wise binary operation with same semantic definition as Math.hypot(double, double) operation applied to each. The implementation is not required to return same results as Math.hypot(double, double), but adheres to rounding, monotonicity, and special case semantics as defined in the Math.hypot(double, double) specifications. The computed result will be within 1 ulp of the exact result.

        Parameters:
        s - the input scalar
        Returns:
        square root of the sum of the squares of this vector and the broadcast of an input scalar

      • hypot

        public FloatVector hypot​(Vector<Float> v,
                         VectorMask<Float> m)
        Calculates square root of the sum of the squares of this vector and an input vector, selecting lane elements controlled by a mask. More specifically as if the following (ignoring any differences in numerical accuracy): 
        
   this.mul(this, m).add(v.mul(v), m).sqrt(m)

        Semantics for rounding, monotonicity, and special cases are described in hypot(jdk.incubator.vector.Vector<java.lang.Float>)

        Parameters:
        v - the input vector
        m - the mask controlling lane selection
        Returns:
        square root of the sum of the squares of this vector and an input vector

      • hypot

        public abstract FloatVector hypot​(float s,
                                  VectorMask<Float> m)
        Calculates square root of the sum of the squares of this vector and the broadcast of an input scalar, selecting lane elements controlled by a mask. More specifically as if the following (ignoring any differences in numerical accuracy): 
        
   this.mul(this, m).add(EVector.broadcast(this.species(), s * s), m).sqrt(m)

        Semantics for rounding, monotonicity, and special cases are described in hypot(jdk.incubator.vector.Vector<java.lang.Float>)

        Parameters:
        s - the input scalar
        m - the mask controlling lane selection
        Returns:
        square root of the sum of the squares of this vector and the broadcast of an input scalar

      • addAll

        public abstract float addAll()
        Adds all lane elements of this vector.

        This is a cross-lane reduction operation which applies the addition operation (+) to lane elements, and the identity value is 0.0.

        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 code for the underlying platform at runtime. If the platform supports a vector instruction to add all values in the vector, or if there is some other efficient machine code sequence, then the JVM has the option of generating this machine code. Otherwise, the default implementation of adding vectors sequentially from left to right is used. For this reason, the output of this method may vary for the same input values.

        Returns:
        the addition of all the lane elements of this vector

      • addAll

        public abstract float addAll​(VectorMask<Float> m)
        Adds all lane elements of this vector, selecting lane elements controlled by a mask.

        This is a cross-lane reduction operation which applies the addition operation (+) to lane elements, and the identity value is 0.0.

        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 code for the underlying platform at runtime. If the platform supports a vector instruction to add all values in the vector, or if there is some other efficient machine code sequence, then the JVM has the option of generating this machine code. Otherwise, the default implementation of adding vectors sequentially from left to right is used. For this reason, the output of this method may vary on the same input values.

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the addition of the selected lane elements of this vector

      • mulAll

        public abstract float mulAll()
        Multiplies all lane elements of this vector.

        This is a cross-lane reduction operation which applies the multiplication operation (*) to lane elements, and the identity value is 1.0.

        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 instruction to multiply all values in the vector, or if there is some other efficient machine code sequence, then the JVM has the option of generating this machine code. Otherwise, the default implementation of multiplying vectors sequentially from left to right is used. For this reason, the output of this method may vary on the same input values.

        Returns:
        the multiplication of all the lane elements of this vector

      • mulAll

        public abstract float mulAll​(VectorMask<Float> m)
        Multiplies all lane elements of this vector, selecting lane elements controlled by a mask.

        This is a cross-lane reduction operation which applies the multiplication operation (*) to lane elements, and the identity value is 1.0.

        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 instruction to multiply all values in the vector, or if there is some other efficient machine code sequence, then the JVM has the option of generating this machine code. Otherwise, the default implementation of multiplying vectors sequentially from left to right is used. For this reason, the output of this method may vary on the same input values.

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the multiplication of all the lane elements of this vector

      • minAll

        public abstract float minAll()
        Returns the minimum lane element of this vector.

        This is an associative cross-lane reduction operation which applies the operation (a, b) -> Math.min(a, b) to lane elements, and the identity value is Float.POSITIVE_INFINITY.

        Returns:
        the minimum lane element of this vector

      • minAll

        public abstract float minAll​(VectorMask<Float> m)
        Returns the minimum lane element of this vector, selecting lane elements controlled by a mask.

        This is an associative cross-lane reduction operation which applies the operation (a, b) -> Math.min(a, b) to lane elements, and the identity value is Float.POSITIVE_INFINITY.

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the minimum lane element of this vector

      • maxAll

        public abstract float maxAll()
        Returns the maximum lane element of this vector.

        This is an associative cross-lane reduction operation which applies the operation (a, b) -> Math.max(a, b) to lane elements, and the identity value is Float.NEGATIVE_INFINITY.

        Returns:
        the maximum lane element of this vector

      • maxAll

        public abstract float maxAll​(VectorMask<Float> m)
        Returns the maximum lane element of this vector, selecting lane elements controlled by a mask.

        This is an associative cross-lane reduction operation which applies the operation (a, b) -> Math.max(a, b) to lane elements, and the identity value is Float.NEGATIVE_INFINITY.

        Parameters:
        m - the mask controlling lane selection
        Returns:
        the maximum lane element of this vector

      • lane

        public abstract float lane​(int i)
        Gets the lane element at lane index i
        Parameters:
        i - the lane index
        Returns:
        the lane element at lane index i
        Throws:
        IllegalArgumentException - if the index is is out of range (< 0 || >= length())

      • with

        public abstract FloatVector with​(int i,
                                 float e)
        Replaces the lane element of this vector at lane index i with value e.

        This is a cross-lane operation and behaves as if it returns the result of blending this vector with an input vector that is the result of broadcasting e and a mask that has only one lane set at lane index i.

        Parameters:
        i - the lane index of the lane element to be replaced
        e - the value to be placed
        Returns:
        the result of replacing the lane element of this vector at lane index i with value e.
        Throws:
        IllegalArgumentException - if the index is is out of range (< 0 || >= length())

      • toArray

        public final float[] toArray()
        Returns an array containing the lane elements of this vector.

        This method behaves as if it intoArray(float[], int) stores} this vector into an allocated array and returns the array as follows: 

        
   float[] a = new float[this.length()];
   this.intoArray(a, 0);
   return a;
        Returns:
        an array containing the the lane elements of this vector

      • intoArray

        public abstract void intoArray​(float[] a,
                               int offset)
        Stores this vector into an array starting at offset.

        For each vector lane, where N is the vector lane index, the lane element at index N is stored into the array at index offset + N.

        Parameters:
        a - the array
        offset - the offset into the array
        Throws:
        IndexOutOfBoundsException - if offset < 0, or offset > a.length - this.length()

      • intoArray

        public abstract void intoArray​(float[] a,
                               int offset,
                               VectorMask<Float> m)
        Stores this vector into an array starting at offset and using a mask.

        For each vector lane, where N is the vector lane index, if the mask lane at index N is set then the lane element at index N is stored into the array index offset + N.

        Parameters:
        a - the array
        offset - the offset into the array
        m - the mask
        Throws:
        IndexOutOfBoundsException - if offset < 0, or for any vector lane index N where the mask at lane N is set offset >= a.length - N

      • intoArray

        public abstract void intoArray​(float[] a,
                               int a_offset,
                               int[] indexMap,
                               int i_offset)
        Stores this vector into an array using indexes obtained from an index map.

        For each vector lane, where N is the vector lane index, the lane element at index N is stored into the array at index a_offset + indexMap[i_offset + N].

        Parameters:
        a - the array
        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
        indexMap - the index map
        i_offset - the offset into the index map
        Throws:
        IndexOutOfBoundsException - if i_offset < 0, or i_offset > indexMap.length - this.length(), or for any vector lane index N the result of a_offset + indexMap[i_offset + N] is < 0 or >= a.length

      • intoArray

        public abstract void intoArray​(float[] a,
                               int a_offset,
                               VectorMask<Float> m,
                               int[] indexMap,
                               int i_offset)
        Stores this vector into an array using indexes obtained from an index map and using a mask.

        For each vector lane, where N is the vector lane index, if the mask lane at index N is set then the lane element at index N is stored into the array at index a_offset + indexMap[i_offset + N].

        Parameters:
        a - the array
        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
        m - the mask
        indexMap - the index map
        i_offset - the offset into the index map
        Throws:
        IndexOutOfBoundsException - if j < 0, or i_offset > indexMap.length - this.length(), or for any vector lane index N where the mask at lane N is set the result of a_offset + indexMap[i_offset + N] is < 0 or >= a.length