Add abs, round, floor, ceil operators (#11653)

* Add abs, round, floor, ceil operators

Port of mapbox/mapbox-gl-js#6496

* [ios, macos] Simplified abs, ceiling, floor expressions

* [ios, macos] Added rounding expression function

* [android] - binding integration for round, ceil, floor and abs expressions

* Update mapbox-gl-js to include non-integer rounding test

* Drop extra braces

* mapbox-gl-js -> master

* Update style-spec docs -> PropertyFactory.java

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/expressions/Expression.java

@@ -81,7 +81,6 @@
  * )
  * }
  * </pre>
- *
  */
 public class Expression {
 
@@ -1061,6 +1060,7 @@ public static Expression coalesce(@NonNull Expression... input) {
    * );
    * }
    * </pre>
+   *
    * @return expression
    * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-properties">Style specification</a>
    */
@@ -1081,6 +1081,7 @@ public static Expression properties() {
    * );
    * }
    * </pre>
+   *
    * @return expression
    * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-geometry-types">Style specification</a>
    */
@@ -2294,6 +2295,185 @@ public static Expression max(@Size(min = 1) Number... numbers) {
     return max(numberExpression);
   }
 
+  /**
+   * Rounds the input to the nearest integer.
+   * Halfway values are rounded away from zero.
+   * For example `[\"round\", -1.5]` evaluates to -2.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(round(pi()))
+   * );
+   * }
+   * </pre>
+   *
+   * @param expression number expression to round
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-round">Style specification</a>
+   */
+  public static Expression round(Expression expression) {
+    return new Expression("round", expression);
+  }
+
+  /**
+   * Rounds the input to the nearest integer.
+   * Halfway values are rounded away from zero.
+   * For example `[\"round\", -1.5]` evaluates to -2.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(round(3.14159265359f))
+   * );
+   * }
+   * </pre>
+   *
+   * @param number number to round
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-round">Style specification</a>
+   */
+  public static Expression round(Number number) {
+    return round(literal(number));
+  }
+
+  /**
+   * Returns the absolute value of the input.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(abs(subtract(pi())))
+   * );
+   * }
+   * </pre>
+   *
+   * @param expression number expression to get absolute value from
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-abs">Style specification</a>
+   */
+  public static Expression abs(Expression expression) {
+    return new Expression("abs", expression);
+  }
+
+  /**
+   * Returns the absolute value of the input.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(abs(-3.14159265359f))
+   * );
+   * }
+   * </pre>
+   *
+   * @param number number to get absolute value from
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-abs">Style specification</a>
+   */
+  public static Expression abs(Number number) {
+    return abs(literal(number));
+  }
+
+  /**
+   * Returns the smallest integer that is greater than or equal to the input.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(ceil(pi()))
+   * );
+   * }
+   * </pre>
+   *
+   * @param expression number expression to get value from
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-abs">Style specification</a>
+   */
+  public static Expression ceil(Expression expression) {
+    return new Expression("ceil", expression);
+  }
+
+  /**
+   * Returns the smallest integer that is greater than or equal to the input.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(ceil(3.14159265359))
+   * );
+   * }
+   * </pre>
+   * @param number number to get value from
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-abs">Style specification</a>
+   */
+  public static Expression ceil(Number number) {
+    return ceil(literal(number));
+  }
+
+  /**
+   * Returns the largest integer that is less than or equal to the input.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(floor(pi()))
+   * );
+   * }
+   * </pre>
+   *
+   * @param expression number expression to get value from
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-abs">Style specification</a>
+   */
+  public static Expression floor(Expression expression) {
+    return new Expression("floor", expression);
+  }
+
+  /**
+   * Returns the largest integer that is less than or equal to the input.
+   * <p>
+   * Example usage:
+   * </p>
+   * <pre>
+   * {@code
+   * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id");
+   * circleLayer.setProperties(
+   *     circleRadius(floor(pi()))
+   * );
+   * }
+   * </pre>
+   *
+   * @param number number to get value from
+   * @return expression
+   * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-abs">Style specification</a>
+   */
+  public static Expression floor(Number number) {
+    return floor(literal(number));
+  }
+
   /**
    * Returns the input string converted to uppercase.
    * <p>
@@ -3128,6 +3308,7 @@ public static Interpolator exponential(@NonNull Number base) {
    * );
    * }
    * </pre>
+   *
    * @param expression base number expression
    * @return expression
    * @see <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-interpolate">Style specification</a>

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java

@@ -1856,7 +1856,7 @@ public static PropertyValue<Expression> iconTextFitPadding(Expression value) {
   }
 
   /**
-   * Name of image in sprite to use for drawing an image background. Within literal values and zoom functions, property names enclosed in curly brackets (e.g. `{token}`) are replaced with the value of the named property. Expressions and property functions do not support this syntax; for equivalent functionality in expressions, use the [`concat`](#expressions-concat) and [`get`](#expressions-get) operators.
+   * Name of image in sprite to use for drawing an image background.
    *
    * @param value a String value
    * @return property wrapper around String
@@ -1866,7 +1866,7 @@ public static PropertyValue<String> iconImage(String value) {
   }
 
   /**
-   * Name of image in sprite to use for drawing an image background. Within literal values and zoom functions, property names enclosed in curly brackets (e.g. `{token}`) are replaced with the value of the named property. Expressions and property functions do not support this syntax; for equivalent functionality in expressions, use the [`concat`](#expressions-concat) and [`get`](#expressions-get) operators.
+   * Name of image in sprite to use for drawing an image background.
    *
    * @param value a String value
    * @return property wrapper around String
@@ -2036,7 +2036,7 @@ public static PropertyValue<Expression> textRotationAlignment(Expression value)
   }
 
   /**
-   * Value to use for a text label. Within literal values and zoom functions, property names enclosed in curly brackets (e.g. `{token}`) are replaced with the value of the named property. Expressions and property functions do not support this syntax; for equivalent functionality in expressions, use the [`concat`](#expressions-concat) and [`get`](#expressions-get) operators.
+   * Value to use for a text label.
    *
    * @param value a String value
    * @return property wrapper around String
@@ -2046,7 +2046,7 @@ public static PropertyValue<String> textField(String value) {
   }
 
   /**
-   * Value to use for a text label. Within literal values and zoom functions, property names enclosed in curly brackets (e.g. `{token}`) are replaced with the value of the named property. Expressions and property functions do not support this syntax; for equivalent functionality in expressions, use the [`concat`](#expressions-concat) and [`get`](#expressions-get) operators.
+   * Value to use for a text label.
    *
    * @param value a String value
    * @return property wrapper around String

platform/android/MapboxGLAndroidSDK/src/test/java/com/mapbox/mapboxsdk/style/expressions/ExpressionTest.java

@@ -6,6 +6,7 @@
 
 import java.util.Arrays;
 
+import static com.mapbox.mapboxsdk.style.expressions.Expression.abs;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.acos;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.all;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.any;
@@ -14,6 +15,7 @@
 import static com.mapbox.mapboxsdk.style.expressions.Expression.at;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.atan;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.bool;
+import static com.mapbox.mapboxsdk.style.expressions.Expression.ceil;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.coalesce;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.color;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.concat;
@@ -24,6 +26,7 @@
 import static com.mapbox.mapboxsdk.style.expressions.Expression.e;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.eq;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.exponential;
+import static com.mapbox.mapboxsdk.style.expressions.Expression.floor;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.geometryType;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.get;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.gt;
@@ -56,6 +59,7 @@
 import static com.mapbox.mapboxsdk.style.expressions.Expression.properties;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.rgb;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.rgba;
+import static com.mapbox.mapboxsdk.style.expressions.Expression.round;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.sin;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.sqrt;
 import static com.mapbox.mapboxsdk.style.expressions.Expression.step;
@@ -1105,4 +1109,60 @@ public void testThrowIllegalArgumentExceptionForPropertyValueLiteral() {
     );
     expression.toArray();
   }
+
+  @Test
+  public void testRound() {
+    Object[] expected = new Object[] {"round", 2.2f};
+    Object[] actual = round(2.2f).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
+
+  @Test
+  public void testRoundLiteral() {
+    Object[] expected = new Object[] {"round", 2.2f};
+    Object[] actual = round(literal(2.2f)).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
+
+  @Test
+  public void testAbs() {
+    Object[] expected = new Object[] {"abs", -2.2f};
+    Object[] actual = abs(-2.2f).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
+
+  @Test
+  public void testAbsLiteral() {
+    Object[] expected = new Object[] {"abs", -2.2f};
+    Object[] actual = abs(literal(-2.2f)).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
+
+  @Test
+  public void testCeil() {
+    Object[] expected = new Object[] {"ceil", 2.2f};
+    Object[] actual = ceil(2.2f).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
+
+  @Test
+  public void testCeilLiteral() {
+    Object[] expected = new Object[] {"ceil", 2.2f};
+    Object[] actual = ceil(literal(2.2f)).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
+
+  @Test
+  public void testFloor() {
+    Object[] expected = new Object[] {"floor", 2.2f};
+    Object[] actual = floor(2.2f).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
+
+  @Test
+  public void testFloorLiteral() {
+    Object[] expected = new Object[] {"floor", 2.2f};
+    Object[] actual = floor(literal(2.2f)).toArray();
+    assertTrue("expression should match", Arrays.deepEquals(expected, actual));
+  }
 }

platform/darwin/docs/guides/For Style Authors.md.ejs

@@ -379,18 +379,22 @@ In style specification | Method, function, or predicate type | Format string syn
 `%`                    | `modulus:by:` |
 `^`                    | `raise:toPower:` | `2 ** 2`
 `+`                    | `add:to:` | `1 + 2`
+`abs`                  | `abs:` | `abs(-1)`
 `acos`                 | |
 `asin`                 | |
 `atan`                 | |
+`ceil`                 | `ceiling:` | `ceiling(0.99999)`
 `cos`                  | |
 `e`                    | | `%@` representing `NSNumber` containing `M_E`
+`floor`                | `floor:` | `floor(-0.99999)`
 `ln`                   | `ln:` | `ln(2)`
 `ln2`                  | | `%@` representing `NSNumber` containing `M_LN2`
 `log10`                | `log:` | `log(1)`
 `log2`                 | |
 `max`                  | `max:` | `max({1, 2, 2, 3, 4, 7, 9})`
 `min`                  | `min:` | `min({1, 2, 2, 3, 4, 7, 9})`
 `pi`                   | | `%@` representing `NSNumber` containing `M_PI`
+`round`                | `mgl_round:` | `mgl_round(1.5)`
 `sin`                  | |
 `sqrt`                 | `sqrt:` | `sqrt(2)`
 `tan`                  | |

platform/darwin/docs/guides/Predicates and Expressions.md

@@ -196,6 +196,7 @@ Initializer parameter | Format string syntax | Description
 `mgl_interpolate:withCurveType:parameters:stops:` | `mgl_interpolate:withCurveType:parameters:stops:(x, 'linear', nil, %@)` | Produces continuous, smooth results by interpolating between pairs of input and output values (“stops”). Compared to the `mgl_interpolateWithCurveType:parameters:stops:` custom function, the input expression (that function’s target) is instead passed in as the first argument to this function.
 `mgl_step:from:stops:` | `mgl_step:from:stops:(x, 11, %@)` | Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of input and output values ("stops"). Compared to the `mgl_stepWithMinimum:stops:` custom function, the input expression (that function’s target) is instead passed in as the first argument to this function.
 `mgl_join:` | `mgl_join({'Old', 'MacDonald'})` | Returns the result of concatenating together all the elements of an array in order. Compared to the `stringByAppendingString:` custom function, this function takes only one argument, which is an aggregate expression containing the strings to concatenate.
+`mgl_round:` | `mgl_round(1.5)` | Returns the number rounded to the nearest integer. If the number is halfway between two integers, this function rounds it away from zero.
 `mgl_coalesce:` | `mgl_coalesce({x, y, z})` | Returns the first non-`nil` value from an array of expressions.
 `MGL_LET` | `MGL_LET('age', uppercase('old'), 'name', uppercase('MacDonald'), mgl_join({$age, $name}))` | Any number of variable names interspersed with their assigned `NSExpression` values, followed by an `NSExpression` that may contain references to those variables. Compared to the `mgl_expressionWithContext:` custom function, this function takes the variable names and values inline before the expression that contains references to those variables.
 `MGL_MATCH` | `MGL_MATCH(x, 0, 'zero match', 1, 'one match', 'two match', 'default')` | Evaluates the first expression and returns the value that matches the initial condition. After the first expression condition a pair of matching/return value should be added and a default value.