File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -144,6 +144,23 @@ allows static code analysis tools (e.g. Error Prone's `MissingCasesInEnumSwitch`
144144check) report a problem when the enum definition is updated but the code using
145145it is not.
146146
147+ ### Vector API
148+ It's safe to assume that the JVM has the Vector API
149+ ([ JEP 508] ( https://openjdk.org/jeps/508 ) ) enabled and available at runtime, but
150+ not safe to assume that the Vector API implementation will perform faster than
151+ equivalent scalar code on whatever hardware the engine happens to be running on.
152+
153+ When adding implementations that use the Vector API, be sure to:
154+ * Provide an equivalent scalar implementation in code, if one does not already
155+ exist.
156+ * Use configuration flags and hardware support detection to ensure that
157+ vectorized implementation is only selected when running on hardware where it is
158+ expected to perform better than its scalar equivalent.
159+ * Add tests that ensure the behavior of the vectorized and scalar
160+ implementations match.
161+ * Include micro-benchmarks that demonstrate the performance benefits of the
162+ vectorized implementation compared to the scalar equivalent logic.
163+
147164## Keep pom.xml clean and sorted
148165
149166There are several plugins in place to keep pom.xml clean.
You can’t perform that action at this time.
0 commit comments