[math] Add Xtext operator annotation and extensions.

see #98 Signed-off-by: Stéphane Galland <galland@arakhne.org>
gallandarakhneorg · Jun 7, 2016 · 0da34aa · 0da34aa
1 parent 7bb2e62
commit 0da34aa
Show file tree

Hide file tree

Showing 16 changed files with 10,879 additions and 9,766 deletions.
diff --git a/core/math/src/main/java/org/arakhne/afc/math/extensions/xtext/MatrixExtensions.java b/core/math/src/main/java/org/arakhne/afc/math/extensions/xtext/MatrixExtensions.java
diff --git a/core/math/src/main/java/org/arakhne/afc/math/extensions/xtext/Tuple2DExtensions.java b/core/math/src/main/java/org/arakhne/afc/math/extensions/xtext/Tuple2DExtensions.java
@@ -0,0 +1,176 @@
+/*
+ * $Id$
+ * This file is a part of the Arakhne Foundation Classes, http://www.arakhne.org/afc
+ *
+ * Copyright (c) 2000-2012 Stephane GALLAND.
+ * Copyright (c) 2005-10, Multiagent Team, Laboratoire Systemes et Transports,
+ *                        Universite de Technologie de Belfort-Montbeliard.
+ * Copyright (c) 2013-2016 The original authors, and other authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.arakhne.afc.math.extensions.xtext;
+
+import org.eclipse.xtext.xbase.lib.Pure;
+
+import org.arakhne.afc.math.geometry.d2.Point2D;
+import org.arakhne.afc.math.geometry.d2.Vector2D;
+import org.arakhne.afc.math.matrix.Matrix2d;
+import org.arakhne.afc.vmutil.annotations.XtextOperator;
+import org.arakhne.afc.vmutil.asserts.AssertMessages;
+
+/** Xtext extensions for 2D vectors.
+ *
+ * @author $Author: sgalland$
+ * @version $FullVersion$
+ * @mavengroupid $GroupId$
+ * @mavenartifactid $ArtifactId$
+ * @since 13.0
+ */
+public final class Tuple2DExtensions {
+
+    private Tuple2DExtensions() {
+        //
+    }
+
+    /** Scale this vector: {@code left * right}.
+     *
+     * <p>This function is an implementation of the operator for
+     * the languages that defined or based on the
+     * <a href="https://www.eclipse.org/Xtext/">Xtext framework</a>.
+     *
+     * <p>The operation {@code right * left} is supported by {@link Matrix2d#operator_multiply(double)}.
+     *
+     * @param <V> the type of the vector.
+     * @param left the scaling factor.
+     * @param right the vector.
+     * @return the scaled vector.
+     * @see Vector2D#scale(double)
+     * @see Vector2D#operator_multiply(double)
+     */
+    @Pure
+    @XtextOperator("*")
+    public static <V extends Vector2D<? extends V, ?>> V operator_multiply(double left, V right) {
+        assert right != null : AssertMessages.notNullParameter(1);
+        return right.getGeomFactory().newVector(right.getX() * left, right.getY() * left);
+    }
+
+    /** Scale this vector: {@code left / right}.
+     *
+     * <p>This function is an implementation of the operator for
+     * the languages that defined or based on the
+     * <a href="https://www.eclipse.org/Xtext/">Xtext framework</a>.
+     *
+     * <p>The operation {@code right / left} is supported by {@link Matrix2d#operator_divide(double)}.
+     *
+     * @param <V> the type of the vector.
+     * @param left the scaling factor.
+     * @param right the vector.
+     * @return the scaled vector.
+     * @see Vector2D#operator_divide(double)
+     */
+    @Pure
+    @XtextOperator("/")
+    public static <V extends Vector2D<? extends V, ?>> V operator_divide(double left, V right) {
+        assert right != null : AssertMessages.notNullParameter(1);
+        return right.getGeomFactory().newVector(left / right.getX(), left / right.getY());
+    }
+
+    /** Subtract a vector to this scalar: {@code left - right}.
+     *
+     * <p>This function is an implementation of the operator for
+     * the languages that defined or based on the
+     * <a href="https://www.eclipse.org/Xtext/">Xtext framework</a>.
+     *
+     * <p>The operation {@code right - left} is supported by {@link Vector2D#operator_minus(double)}.
+     *
+     * @param <V> the type of the vector.
+     * @param left the scaling factor.
+     * @param right the vector.
+     * @return the result.
+     * @see Vector2D#sub(Vector2D)
+     * @see Vector2D#operator_minus(double)
+     */
+    @Pure
+    @XtextOperator("-")
+    public static <V extends Vector2D<? extends V, ?>> V operator_minus(double left, V right) {
+        assert right != null : AssertMessages.notNullParameter(1);
+        return right.getGeomFactory().newVector(left - right.getX(), left - right.getY());
+    }
+
+    /** Subtract the scalar to this point: {@code left - right}.
+     *
+     * <p>This function is an implementation of the operator for
+     * the languages that defined or based on the
+     * <a href="https://www.eclipse.org/Xtext/">Xtext framework</a>.
+     *
+     * <p>The operation {@code right + left} is supported by {@link Point2D#operator_minus(double)}.
+     *
+     * @param <P> the type of the point.
+     * @param left the scaling factor.
+     * @param right the vector.
+     * @return the result.
+     * @see Point2D#sub(Point2D, Vector2D)
+     * @see Point2D#operator_minus(double)
+     */
+    @Pure
+    @XtextOperator("-")
+    public static <P extends Point2D<? extends P, ?>> P operator_minus(double left, P right) {
+        assert right != null : AssertMessages.notNullParameter(1);
+        return right.getGeomFactory().newPoint(left - right.getX(), left - right.getY());
+    }
+
+    /** Sum of this vector and the given scalar: {@code left + right}.
+     *
+     * <p>This function is an implementation of the operator for
+     * the languages that defined or based on the
+     * <a href="https://www.eclipse.org/Xtext/">Xtext framework</a>.
+     *
+     * <p>The operation {@code right + left} is supported by {@link Vector2D#operator_plus(double)}.
+     *
+     * @param <V> the type of the vector.
+     * @param left the scaling factor.
+     * @param right the vector.
+     * @return the result.
+     * @see Vector2D#add(Vector2D, Vector2D)
+     * @see Vector2D#operator_plus(double)
+     */
+    @Pure
+    @XtextOperator("+")
+    public static <V extends Vector2D<? extends V, ?>> V operator_plus(double left, V right) {
+        assert right != null : AssertMessages.notNullParameter(1);
+        return right.getGeomFactory().newVector(left + right.getX(), left + right.getY());
+    }
+
+    /** Sum of this point and a scalar: {@code left + right}.
+     *
+     * <p>This function is an implementation of the operator for
+     * the languages that defined or based on the
+     * <a href="https://www.eclipse.org/Xtext/">Xtext framework</a>.
+     *
+     * <p>The operation {@code right + left} is supported by {@link Point2D#operator_plus(double)}.
+     *
+     * @param <P> the type of the point.
+     * @param left the scaling factor.
+     * @param right the vector.
+     * @return the result.
+     * @see Point2D#add(Point2D, Vector2D)
+     * @see Point2D#operator_plus(double)
+     */
+    @Pure
+    @XtextOperator("+")
+    public static <P extends Point2D<? extends P, ?>> P operator_plus(double left, P right) {
+        assert right != null : AssertMessages.notNullParameter(1);
+        return right.getGeomFactory().newPoint(left + right.getX(), left + right.getY());
+    }
+
+}