Skip to content

Commit 751d544

Browse files
osanaosana
authored
Turf name changes
1 parent 1d913a6 commit 751d544

11 files changed

Lines changed: 65 additions & 67 deletions

File tree

‎services-turf/src/main/java/com/mapbox/turf/TurfClassification.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ private TurfClassification() {
2828
* @since 3.0.0
2929
*/
3030
@NonNull
31-
public static Point nearest(@NonNull Point targetPoint, @NonNull List<Point> points) {
31+
public static Point nearestPoint(@NonNull Point targetPoint, @NonNull List<Point> points) {
3232
if (points.isEmpty()) {
3333
return targetPoint;
3434
}

‎services-turf/src/main/java/com/mapbox/turf/TurfConstants.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* between two GeoJson Points using {@link TurfMeasurement#distance(Point, Point, String)} the third
1414
* optional parameter can define the output units.
1515
* <p>
16-
* Note that {@link TurfConversion#convertDistance(double, String, String)} can be used to transform
16+
* Note that {@link TurfConversion#convertLength(double, String, String)} can be used to transform
1717
* one unit to another, such as miles to feet.
1818
* </p>
1919
*

‎services-turf/src/main/java/com/mapbox/turf/TurfConversion.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ private TurfConversion() {
5151
* @return a double value representing the distance in degrees
5252
* @since 3.0.0
5353
*/
54-
public static double distanceToDegrees(double distance, @TurfUnitCriteria String units) {
55-
return radiansToDegrees(distanceToRadians(distance, units));
54+
public static double lengthToDegrees(double distance, @TurfUnitCriteria String units) {
55+
return radiansToDegrees(lengthToRadians(distance, units));
5656
}
5757

5858
/**
@@ -75,8 +75,8 @@ public static double radiansToDegrees(double radians) {
7575
* @return converted radian to distance value
7676
* @since 1.2.0
7777
*/
78-
public static double radiansToDistance(double radians) {
79-
return radiansToDistance(radians, TurfConstants.UNIT_DEFAULT);
78+
public static double radiansToLength(double radians) {
79+
return radiansToLength(radians, TurfConstants.UNIT_DEFAULT);
8080
}
8181

8282
/**
@@ -88,7 +88,7 @@ public static double radiansToDistance(double radians) {
8888
* @return converted radian to distance value
8989
* @since 1.2.0
9090
*/
91-
public static double radiansToDistance(double radians, @NonNull @TurfUnitCriteria String units) {
91+
public static double radiansToLength(double radians, @NonNull @TurfUnitCriteria String units) {
9292
return radians * FACTORS.get(units);
9393
}
9494

@@ -101,8 +101,8 @@ public static double radiansToDistance(double radians, @NonNull @TurfUnitCriteri
101101
* @return converted distance to radians value
102102
* @since 1.2.0
103103
*/
104-
public static double distanceToRadians(double distance) {
105-
return distanceToRadians(distance, TurfConstants.UNIT_DEFAULT);
104+
public static double lengthToRadians(double distance) {
105+
return lengthToRadians(distance, TurfConstants.UNIT_DEFAULT);
106106
}
107107

108108
/**
@@ -114,23 +114,23 @@ public static double distanceToRadians(double distance) {
114114
* @return converted distance to radians value
115115
* @since 1.2.0
116116
*/
117-
public static double distanceToRadians(double distance, @NonNull @TurfUnitCriteria String units) {
117+
public static double lengthToRadians(double distance, @NonNull @TurfUnitCriteria String units) {
118118
return distance / FACTORS.get(units);
119119
}
120120

121121
/**
122122
* Converts a distance to the default units. Use
123-
* {@link TurfConversion#convertDistance(double, String, String)} to specify a unit to convert to.
123+
* {@link TurfConversion#convertLength(double, String, String)} to specify a unit to convert to.
124124
*
125125
* @param distance double representing a distance value
126126
* @param originalUnit of the distance, must be one of the units defined in
127127
* {@link TurfUnitCriteria}
128128
* @return converted distance in the default unit
129129
* @since 2.2.0
130130
*/
131-
public static double convertDistance(@FloatRange(from = 0) double distance,
132-
@NonNull @TurfUnitCriteria String originalUnit) {
133-
return convertDistance(distance, originalUnit, TurfConstants.UNIT_DEFAULT);
131+
public static double convertLength(@FloatRange(from = 0) double distance,
132+
@NonNull @TurfUnitCriteria String originalUnit) {
133+
return convertLength(distance, originalUnit, TurfConstants.UNIT_DEFAULT);
134134
}
135135

136136
/**
@@ -143,12 +143,12 @@ public static double convertDistance(@FloatRange(from = 0) double distance,
143143
* @return the converted distance
144144
* @since 2.2.0
145145
*/
146-
public static double convertDistance(@FloatRange(from = 0) double distance,
147-
@NonNull @TurfUnitCriteria String originalUnit,
148-
@Nullable @TurfUnitCriteria String finalUnit) {
146+
public static double convertLength(@FloatRange(from = 0) double distance,
147+
@NonNull @TurfUnitCriteria String originalUnit,
148+
@Nullable @TurfUnitCriteria String finalUnit) {
149149
if (finalUnit == null) {
150150
finalUnit = TurfConstants.UNIT_DEFAULT;
151151
}
152-
return radiansToDistance(distanceToRadians(distance, originalUnit), finalUnit);
152+
return radiansToLength(lengthToRadians(distance, originalUnit), finalUnit);
153153
}
154154
}

‎services-turf/src/main/java/com/mapbox/turf/TurfJoins.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public static boolean inside(Point point, MultiPolygon multiPolygon) {
8383
* @return points that land within at least one polygon.
8484
* @since 1.3.0
8585
*/
86-
public static FeatureCollection within(FeatureCollection points, FeatureCollection polygons) {
86+
public static FeatureCollection pointsWithinPolygon(FeatureCollection points, FeatureCollection polygons) {
8787
ArrayList<Feature> features = new ArrayList<>();
8888
for (int i = 0; i < polygons.features().size(); i++) {
8989
for (int j = 0; j < points.features().size(); j++) {

‎services-turf/src/main/java/com/mapbox/turf/TurfMeasurement.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public static Point destination(@NonNull Point point, @FloatRange(from = 0) doub
7272
double latitude1 = degrees2radians * point.latitude();
7373
double bearingRad = degrees2radians * bearing;
7474

75-
double radians = TurfConversion.distanceToRadians(distance, units);
75+
double radians = TurfConversion.lengthToRadians(distance, units);
7676

7777
double latitude2 = Math.asin(Math.sin(latitude1) * Math.cos(radians)
7878
+ Math.cos(latitude1) * Math.sin(radians) * Math.cos(bearingRad));
@@ -120,7 +120,7 @@ public static double distance(@NonNull Point point1, @NonNull Point point2,
120120
double a = Math.pow(Math.sin(dLat / 2), 2)
121121
+ Math.pow(Math.sin(dLon / 2), 2) * Math.cos(lat1) * Math.cos(lat2);
122122

123-
return TurfConversion.radiansToDistance(
123+
return TurfConversion.radiansToLength(
124124
2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a)), units);
125125
}
126126

@@ -133,8 +133,8 @@ public static double distance(@NonNull Point point1, @NonNull Point point2,
133133
* @see <a href="http://turfjs.org/docs/#linedistance">Turf Line Distance documentation</a>
134134
* @since 1.2.0
135135
*/
136-
public static double lineDistance(@NonNull LineString lineString,
137-
@NonNull @TurfConstants.TurfUnitCriteria String units) {
136+
public static double length(@NonNull LineString lineString,
137+
@NonNull @TurfConstants.TurfUnitCriteria String units) {
138138
List<Point> coordinates = lineString.coordinates();
139139
return length(coordinates, units);
140140
}
@@ -148,8 +148,8 @@ public static double lineDistance(@NonNull LineString lineString,
148148
* @see <a href="http://turfjs.org/docs/#linedistance">Turf Line Distance documentation</a>
149149
* @since 1.2.0
150150
*/
151-
public static double lineDistance(@NonNull MultiLineString multiLineString,
152-
@NonNull @TurfConstants.TurfUnitCriteria String units) {
151+
public static double length(@NonNull MultiLineString multiLineString,
152+
@NonNull @TurfConstants.TurfUnitCriteria String units) {
153153
double d = 0;
154154
for (List<Point> points : multiLineString.coordinates()) {
155155
d += length(points, units);
@@ -167,8 +167,8 @@ public static double lineDistance(@NonNull MultiLineString multiLineString,
167167
* @see <a href="http://turfjs.org/docs/#linedistance">Turf Line Distance documentation</a>
168168
* @since 1.2.0
169169
*/
170-
public static double lineDistance(@NonNull Polygon polygon,
171-
@NonNull @TurfConstants.TurfUnitCriteria String units) {
170+
public static double length(@NonNull Polygon polygon,
171+
@NonNull @TurfConstants.TurfUnitCriteria String units) {
172172
double d = 0;
173173
for (List<Point> points : polygon.coordinates()) {
174174
d += length(points, units);
@@ -186,8 +186,8 @@ public static double lineDistance(@NonNull Polygon polygon,
186186
* @see <a href="http://turfjs.org/docs/#linedistance">Turf Line Distance documentation</a>
187187
* @since 1.2.0
188188
*/
189-
public static double lineDistance(@NonNull MultiPolygon multiPolygon,
190-
@NonNull @TurfConstants.TurfUnitCriteria String units) {
189+
public static double length(@NonNull MultiPolygon multiPolygon,
190+
@NonNull @TurfConstants.TurfUnitCriteria String units) {
191191
double d = 0;
192192
List<List<List<Point>>> coordinates = multiPolygon.coordinates();
193193
for (List<List<Point>> coordinate : coordinates) {

‎services-turf/src/main/java/com/mapbox/turf/TurfMisc.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ public static LineString lineSlice(@NonNull Point startPt, @NonNull Point stopPt
7171
throw new TurfException("Start and stop points in Turf lineSlice cannot equal each other.");
7272
}
7373

74-
Feature startVertex = pointOnLine(startPt, coords);
75-
Feature stopVertex = pointOnLine(stopPt, coords);
74+
Feature startVertex = nearestPointOnLine(startPt, coords);
75+
Feature stopVertex = nearestPointOnLine(stopPt, coords);
7676
List<Feature> ends = new ArrayList<>();
7777
if ((int) startVertex.getNumberProperty(INDEX_KEY)
7878
<= (int) stopVertex.getNumberProperty(INDEX_KEY)) {
@@ -102,10 +102,10 @@ public static LineString lineSlice(@NonNull Point startPt, @NonNull Point stopPt
102102
* @since 1.3.0
103103
*/
104104
@NonNull
105-
public static Feature pointOnLine(@NonNull Point pt, @NonNull List<Point> coords) {
105+
public static Feature nearestPointOnLine(@NonNull Point pt, @NonNull List<Point> coords) {
106106

107107
if (coords.size() < 2) {
108-
throw new TurfException("Turf pointOnLine requires a List of Points made up of at least 2 "
108+
throw new TurfException("Turf nearestPointOnLine requires a List of Points made up of at least 2 "
109109
+ "coordinates.");
110110
}
111111

‎services-turf/src/test/java/com/mapbox/turf/TurfClassificationTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public void testLineDistanceWithGeometries() throws IOException, TurfException {
2626
for (Feature feature : pts.features()) {
2727
pointList.add((Point) (feature.geometry()));
2828
}
29-
Point closestPt = TurfClassification.nearest(pt, pointList);
29+
Point closestPt = TurfClassification.nearestPoint(pt, pointList);
3030

3131
Assert.assertNotNull(closestPt);
3232
Assert.assertEquals(closestPt.type(), "Point");

‎services-turf/src/test/java/com/mapbox/turf/TurfConversionTest.java‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,48 +16,48 @@ public class TurfConversionTest extends TestUtils {
1616
@Test
1717
public void radiansToDistance() throws Exception {
1818
assertEquals(
19-
1, TurfConversion.radiansToDistance(1, TurfConstants.UNIT_RADIANS), DELTA);
19+
1, TurfConversion.radiansToLength(1, TurfConstants.UNIT_RADIANS), DELTA);
2020
assertEquals(
21-
6373, TurfConversion.radiansToDistance(1, TurfConstants.UNIT_KILOMETERS), DELTA);
21+
6373, TurfConversion.radiansToLength(1, TurfConstants.UNIT_KILOMETERS), DELTA);
2222
assertEquals(
23-
3960, TurfConversion.radiansToDistance(1, TurfConstants.UNIT_MILES), DELTA);
23+
3960, TurfConversion.radiansToLength(1, TurfConstants.UNIT_MILES), DELTA);
2424
}
2525

2626
@Test
2727
public void distanceToRadians() throws Exception {
2828
assertEquals(
29-
1, TurfConversion.distanceToRadians(1, TurfConstants.UNIT_RADIANS), DELTA);
29+
1, TurfConversion.lengthToRadians(1, TurfConstants.UNIT_RADIANS), DELTA);
3030
assertEquals(
31-
1, TurfConversion.distanceToRadians(6373, TurfConstants.UNIT_KILOMETERS), DELTA);
31+
1, TurfConversion.lengthToRadians(6373, TurfConstants.UNIT_KILOMETERS), DELTA);
3232
assertEquals(
33-
1, TurfConversion.distanceToRadians(3960, TurfConstants.UNIT_MILES), DELTA);
33+
1, TurfConversion.lengthToRadians(3960, TurfConstants.UNIT_MILES), DELTA);
3434
}
3535

3636
@Test
3737
public void distanceToDegrees() throws Exception {
3838
assertEquals(
39-
57.29577951308232, TurfConversion.distanceToDegrees(1, TurfConstants.UNIT_RADIANS), DELTA);
39+
57.29577951308232, TurfConversion.lengthToDegrees(1, TurfConstants.UNIT_RADIANS), DELTA);
4040
assertEquals(
41-
0.8990393772647469, TurfConversion.distanceToDegrees(100,
41+
0.8990393772647469, TurfConversion.lengthToDegrees(100,
4242
TurfConstants.UNIT_KILOMETERS), DELTA);
4343
assertEquals(
44-
0.14468631190172304, TurfConversion.distanceToDegrees(10, TurfConstants.UNIT_MILES), DELTA);
44+
0.14468631190172304, TurfConversion.lengthToDegrees(10, TurfConstants.UNIT_MILES), DELTA);
4545
}
4646

4747
@Test
4848
public void convertDistance() throws TurfException {
4949
assertEquals(1,
50-
TurfConversion.convertDistance(1000, TurfConstants.UNIT_METERS), DELTA);
50+
TurfConversion.convertLength(1000, TurfConstants.UNIT_METERS), DELTA);
5151
assertEquals(0.6213714106386318,
52-
TurfConversion.convertDistance(1, TurfConstants.UNIT_KILOMETERS,
52+
TurfConversion.convertLength(1, TurfConstants.UNIT_KILOMETERS,
5353
TurfConstants.UNIT_MILES), DELTA);
5454
assertEquals(1.6093434343434343,
55-
TurfConversion.convertDistance(1, TurfConstants.UNIT_MILES,
55+
TurfConversion.convertLength(1, TurfConstants.UNIT_MILES,
5656
TurfConstants.UNIT_KILOMETERS), DELTA);
5757
assertEquals(1.851999843075488,
58-
TurfConversion.convertDistance(1, TurfConstants.UNIT_NAUTICAL_MILES), DELTA);
58+
TurfConversion.convertLength(1, TurfConstants.UNIT_NAUTICAL_MILES), DELTA);
5959
assertEquals(100,
60-
TurfConversion.convertDistance(1, TurfConstants.UNIT_METERS,
60+
TurfConversion.convertLength(1, TurfConstants.UNIT_METERS,
6161
TurfConstants.UNIT_CENTIMETERS), DELTA);
6262
}
6363
}

‎services-turf/src/test/java/com/mapbox/turf/TurfJoinsTest.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
import com.mapbox.geojson.Feature;
44
import com.mapbox.core.TestUtils;
55
import com.mapbox.geojson.FeatureCollection;
6-
import com.mapbox.geojson.MultiPoint;
76
import com.mapbox.geojson.MultiPolygon;
87
import com.mapbox.geojson.Point;
98
import com.mapbox.geojson.Polygon;
@@ -129,7 +128,7 @@ public void testWithin() throws TurfException {
129128
features2.add(Feature.fromGeometry(pt));
130129
FeatureCollection ptFeatureCollection = FeatureCollection.fromFeatures(features2);
131130

132-
FeatureCollection counted = TurfJoins.within(ptFeatureCollection, polyFeatureCollection);
131+
FeatureCollection counted = TurfJoins.pointsWithinPolygon(ptFeatureCollection, polyFeatureCollection);
133132
assertNotNull(counted);
134133
assertEquals(counted.features().size(), 1); // 1 point in 1 polygon
135134

@@ -162,7 +161,7 @@ public void testWithin() throws TurfException {
162161
Feature.fromGeometry(pt1), Feature.fromGeometry(pt2), Feature.fromGeometry(pt3),
163162
Feature.fromGeometry(pt4), Feature.fromGeometry(pt5), Feature.fromGeometry(pt6)});
164163

165-
counted = TurfJoins.within(ptFeatureCollection, polyFeatureCollection);
164+
counted = TurfJoins.pointsWithinPolygon(ptFeatureCollection, polyFeatureCollection);
166165
assertNotNull(counted);
167166
assertEquals(counted.features().size(), 5); // multiple points in multiple polygons
168167
}

‎services-turf/src/test/java/com/mapbox/turf/TurfMeasurementTest.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,32 +87,32 @@ public void lineDistance_returnsZeroWhenRouteIsPoint() throws Exception {
8787
coords.add(Point.fromLngLat(1.0, 1.0));
8888

8989
LineString lineString = LineString.fromLngLats(coords);
90-
double distance = TurfMeasurement.lineDistance(lineString, TurfConstants.UNIT_METERS);
90+
double distance = TurfMeasurement.length(lineString, TurfConstants.UNIT_METERS);
9191
assertEquals(0d, distance, DELTA);
9292
}
9393

9494
@Test
9595
public void testLineDistanceWithGeometries() throws IOException, TurfException {
9696
Feature route1 = Feature.fromJson(loadJsonFixture(LINE_DISTANCE_ROUTE_ONE));
9797
Feature route2 = Feature.fromJson(loadJsonFixture(LINE_DISTANCE_ROUTE_TWO));
98-
assertEquals(202, Math.round(TurfMeasurement.lineDistance((LineString) route1.geometry(),
98+
assertEquals(202, Math.round(TurfMeasurement.length((LineString) route1.geometry(),
9999
TurfConstants.UNIT_MILES)));
100100
Assert.assertEquals(741.7787396994203,
101-
TurfMeasurement.lineDistance((LineString) route2.geometry(), TurfConstants.UNIT_KILOMETERS), DELTA);
101+
TurfMeasurement.length((LineString) route2.geometry(), TurfConstants.UNIT_KILOMETERS), DELTA);
102102
}
103103

104104
@Test
105105
public void testLineDistancePolygon() throws IOException, TurfException {
106106
Feature feature = Feature.fromJson(loadJsonFixture(LINE_DISTANCE_POLYGON));
107-
assertEquals(5599, Math.round(1000 * TurfMeasurement.lineDistance((Polygon) feature.geometry(),
107+
assertEquals(5599, Math.round(1000 * TurfMeasurement.length((Polygon) feature.geometry(),
108108
TurfConstants.UNIT_KILOMETERS)));
109109
}
110110

111111
@Test
112112
public void testLineDistanceMultiLineString() throws IOException, TurfException {
113113
Feature feature = Feature.fromJson(loadJsonFixture(LINE_DISTANCE_MULTILINESTRING));
114114
assertEquals(4705d, Math.round(1000
115-
* TurfMeasurement.lineDistance((MultiLineString) feature.geometry(),
115+
* TurfMeasurement.length((MultiLineString) feature.geometry(),
116116
TurfConstants.UNIT_KILOMETERS)), DELTA);
117117
}
118118

0 commit comments

Comments
 (0)