Nested and Inner Type Summary

Modifier and Type	Class and Description
private static record	VectorMathLibrary.Entry<T>
private static class	VectorMathLibrary.Java
pack-priv static interface	VectorMathLibrary.Library
private static class	VectorMathLibrary.SLEEF Naming convention in SLEEF-based vector math library .
private static class	VectorMathLibrary.SVML Naming convention in SVML vector math library.

Field Summary

Modifier and Type	Field and Description
private static final VectorMathLibrary.Library	LIBRARY
private static final VectorMathLibrary.Entry<?>[][][]	LIBRARY_ENTRIES
private static final SymbolLookup	LOOKUP
private static final int	SIZE

Access	Constructor and Description
pack-priv	VectorMathLibrary()

Method Summary

Modifier and Type	Method and Description
pack-priv static <E, V extends Vector<E>> V	binaryMathOp(VectorOperators.Binary op, int opc, AbstractSpecies<E> vspecies, IntFunction<VectorSupport.BinaryOperation<V, ?>> implSupplier, V v1, V v2)
private static <E, T> VectorMathLibrary.Entry<T>	constructEntry(VectorOperators.Operator op, int opc, VectorSpecies<E> vspecies, IntFunction<T> implSupplier)
private static <T> VectorMathLibrary.Entry<T>	lookup(VectorOperators.Operator op, int opc, VectorSpecies<?> vspecies, IntFunction<T> implSupplier)
pack-priv static <E, V extends Vector<E>> V	unaryMathOp(VectorOperators.Unary op, int opc, AbstractSpecies<E> vspecies, IntFunction<VectorSupport.UnaryOperation<V, ?>> implSupplier, V v)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

LIBRARY	back to summary
private static final VectorMathLibrary.Library LIBRARY

LIBRARY_ENTRIES	back to summary
private static final VectorMathLibrary.Entry<?>[][][] LIBRARY_ENTRIES Annotations @Stable

LOOKUP	back to summary
private static final SymbolLookup LOOKUP

SIZE	back to summary
private static final int SIZE

VectorMathLibrary	back to summary
pack-priv VectorMathLibrary()

Method Detail

binaryMathOp	back to summary
pack-priv static <E, V extends Vector<E>> V binaryMathOp(VectorOperators.Binary op, int opc, AbstractSpecies<E> vspecies, IntFunction<VectorSupport.BinaryOperation<V, ?>> implSupplier, V v1, V v2) Annotations @ForceInline

constructEntry	back to summary
private static <E, T> VectorMathLibrary.Entry<T> constructEntry(VectorOperators.Operator op, int opc, VectorSpecies<E> vspecies, IntFunction<T> implSupplier) Annotations @DontInline

lookup	back to summary
private static <T> VectorMathLibrary.Entry<T> lookup(VectorOperators.Operator op, int opc, VectorSpecies<?> vspecies, IntFunction<T> implSupplier) Annotations @ForceInline

unaryMathOp	back to summary
pack-priv static <E, V extends Vector<E>> V unaryMathOp(VectorOperators.Unary op, int opc, AbstractSpecies<E> vspecies, IntFunction<VectorSupport.UnaryOperation<V, ?>> implSupplier, V v) Annotations @ForceInline

jdk.incubator.vector back to summary

private final Record VectorMathLibrary.Entry<T>

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.incubator.vector.VectorMathLibrary.Entry

Record Components

name:String
entry:MemorySegment
impl:T

Field Summary

Modifier and Type	Field and Description
private final MemorySegment	entry Record Component accessed by entry().
private final T	impl Record Component accessed by impl().
private final String	name Record Component accessed by name().

Constructor Summary

Access	Constructor and Description
private	Entry(String name, MemorySegment entry, T impl)

Method Summary

Modifier and Type	Method and Description
public MemorySegment	entry() Record Component getter of entry.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public T	impl() Record Component getter of impl.
public String	name() Record Component getter of name.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

entry	back to summary
private final MemorySegment entry Record Component accessed by entry().

impl	back to summary
private final T impl Record Component accessed by impl().

name	back to summary
private final String name Record Component accessed by name().

Constructor Detail

Entry	back to summary
private Entry(String name, MemorySegment entry, T impl)

Method Detail

entry	back to summary
public MemorySegment entry() Record Component getter of entry.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

impl	back to summary
public T impl() Record Component getter of impl.

name	back to summary
public String name() Record Component getter of name.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

jdk.incubator.vector back to summary

private Class VectorMathLibrary.Java

Class Inheritance

extends Object
implements Library

java.lang.Object
jdk.incubator.vector.VectorMathLibrary.Java

All Implemented Interfaces

jdk.incubator.vector.VectorMathLibrary.Library

Constructor Summary

Access	Constructor and Description
private	Java()

Method Summary

Modifier and Type	Method and Description
public boolean	isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.isSupported.
public String	symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.symbolName.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Java	back to summary
private Java()

Method Detail

isSupported	back to summary
public boolean isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.isSupported. Annotations @Override

isSupported

back to summary

public boolean isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies)

Implements jdk.incubator.vector.VectorMathLibrary.Library.isSupported.

Annotations

@Override

symbolName	back to summary
public String symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.symbolName. Annotations @Override

symbolName

back to summary

public String symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies)

Implements jdk.incubator.vector.VectorMathLibrary.Library.symbolName.

Annotations

@Override

jdk.incubator.vector back to summary

pack-priv Interface VectorMathLibrary.Library

Known Direct Implementers: jdk.incubator.vector.VectorMathLibrary.Java, jdk.incubator.vector.VectorMathLibrary.SVML, jdk.incubator.vector.VectorMathLibrary.SLEEF

Field Summary

Modifier and Type	Field and Description
public static final String	JAVA
public static final String	SLEEF
public static final String	SVML

Method Summary

Modifier and Type	Method and Description
public static String	getDefaultName()
public static VectorMathLibrary.Library	getInstance()
public boolean	isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies)
public String	symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies)

Field Detail

JAVA	back to summary
public static final String JAVA

SLEEF	back to summary
public static final String SLEEF

SVML	back to summary
public static final String SVML

Method Detail

getDefaultName	back to summary
public static String getDefaultName()

getInstance	back to summary
public static VectorMathLibrary.Library getInstance()

isSupported	back to summary
public boolean isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies)

symbolName	back to summary
public String symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies)

jdk.incubator.vector back to summary

private Class VectorMathLibrary.SLEEF

Class Inheritance

extends Object
implements Library

java.lang.Object
jdk.incubator.vector.VectorMathLibrary.SLEEF

All Implemented Interfaces

jdk.incubator.vector.VectorMathLibrary.Library

Naming convention in SLEEF-based vector math library . All the methods are named as _ where: is the operation name, e.g. sin is optional to indicate float/double "f/d" for vector float/double operation is the number of elements in the vector "2/4" for neon, and "x" for sve/rvv is the precision level "u10/u05" represents 1.0/0.5 ULP error bounds We use "u10" for all operations by default But for those functions do not have u10 support, we use "u05" instead indicates neon/sve/rvv "sve/advsimd/rvv" for sve/neon/rvv implementations e.g. sinfx_u10sve is the method for computing vector float sin using SVE instructions cosd2_u10advsimd is the method for computing 2 elements vector double cos using NEON instructions

Constructor Summary

Access	Constructor and Description
private	SLEEF()

Method Summary

Modifier and Type	Method and Description
public boolean	isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.isSupported.
private static String	precisionLevel(VectorOperators.Operator op)
private static String	suffix(VectorShape vshape, boolean isShapeAgnostic)
public String	symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.symbolName.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SLEEF	back to summary
private SLEEF()

Method Detail

isSupported	back to summary
public boolean isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.isSupported. Annotations @Override

isSupported

back to summary

public boolean isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies)

Implements jdk.incubator.vector.VectorMathLibrary.Library.isSupported.

Annotations

@Override

precisionLevel	back to summary
private static String precisionLevel(VectorOperators.Operator op)

suffix	back to summary
private static String suffix(VectorShape vshape, boolean isShapeAgnostic)

symbolName	back to summary
public String symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.symbolName. Annotations @Override

symbolName

back to summary

public String symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies)

Implements jdk.incubator.vector.VectorMathLibrary.Library.symbolName.

Annotations

@Override

jdk.incubator.vector back to summary

private Class VectorMathLibrary.SVML

Class Inheritance

extends Object
implements Library

java.lang.Object
jdk.incubator.vector.VectorMathLibrary.SVML

All Implemented Interfaces

jdk.incubator.vector.VectorMathLibrary.Library

Naming convention in SVML vector math library. All the methods are named as __jsvml__ha_ where: ha stands for high accuracy is optional to indicate float/double Set to f for vector float operation Omitted for vector double operation is the number of elements in the vector 1, 2, 4, 8, 16 e.g. 128 bit float vector has 4 float elements indicates the avx/sse level: z0 is AVX512, l9 is AVX2, e9 is AVX1 and ex is for SSE2 e.g. __jsvml_expf16_ha_z0 is the method for computing 16 element vector float exp using AVX 512 insns __jsvml_exp8_ha_z0 is the method for computing 8 element vector double exp using AVX 512 insns

Constructor Summary

Access	Constructor and Description
private	SVML()

Method Summary

Modifier and Type	Method and Description
public boolean	isSupported(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.isSupported.
private static void	loadNativeLibrary()
private static String	suffix(VectorSpecies<?> vspecies)
public String	symbolName(VectorOperators.Operator op, VectorSpecies<?> vspecies) Implements jdk.incubator.vector.VectorMathLibrary.Library.symbolName.