Enum GeometryArray

pub enum GeometryArray<O: OffsetSizeTrait> {
    Point(PointArray),
    LineString(LineStringArray<O>),
    Polygon(PolygonArray<O>),
    MultiPoint(MultiPointArray<O>),
    MultiLineString(MultiLineStringArray<O>),
    MultiPolygon(MultiPolygonArray<O>),
    Rect(RectArray),
}

A GeometryArray is an enum over the various underlying zero copy GeoArrow array types.

Notably this does not include WKBArray as a variant, because that is not zero-copy to parse.

Variants

Point(PointArray)

LineString(LineStringArray<O>)

Polygon(PolygonArray<O>)

MultiPoint(MultiPointArray<O>)

MultiLineString(MultiLineStringArray<O>)

MultiPolygon(MultiPolygonArray<O>)

Rect(RectArray)

Trait Implementations

impl<O: OffsetSizeTrait> AffineOps<AffineTransform> for GeometryArray<O>

fn affine_transform(&self, transform: &AffineTransform) -> Self

Apply transform immutably, outputting a new geometry.

impl<O: OffsetSizeTrait> AffineOps<Vec<AffineTransform>> for GeometryArray<O>

fn affine_transform(&self, transform: &Vec<AffineTransform>) -> Self

Apply transform immutably, outputting a new geometry.

impl<O: OffsetSizeTrait> Area for GeometryArray<O>

fn signed_area(&self) -> Float64Array

fn unsigned_area(&self) -> Float64Array

impl<O: OffsetSizeTrait> BoundingRect for GeometryArray<O>

fn bounding_rect(&self) -> RectArray

Return the bounding rectangle of a geometry

impl<O: OffsetSizeTrait> Center for GeometryArray<O>

fn center(&self) -> PointArray

impl<O: OffsetSizeTrait> Centroid for GeometryArray<O>

fn centroid(&self) -> PointArray

See: https://en.wikipedia.org/wiki/Centroid

impl<O: OffsetSizeTrait> ChamberlainDuquetteArea for GeometryArray<O>

fn chamberlain_duquette_signed_area(&self) -> Float64Array

fn chamberlain_duquette_unsigned_area(&self) -> Float64Array

impl<O: Clone + OffsetSizeTrait> Clone for GeometryArray<O>

fn clone(&self) -> GeometryArray<O>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<O: OffsetSizeTrait> ConvexHull<O> for GeometryArray<O>

fn convex_hull(&self) -> PolygonArray<O>

impl<O: Debug + OffsetSizeTrait> Debug for GeometryArray<O>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<GeometryArray<i32>> for GeometryArray<i64>

fn from(value: GeometryArray<i32>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<LineStringArray<O>> for GeometryArray<O>

fn from(value: LineStringArray<O>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<MultiLineStringArray<O>> for GeometryArray<O>

fn from(value: MultiLineStringArray<O>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<MultiPointArray<O>> for GeometryArray<O>

fn from(value: MultiPointArray<O>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<MultiPolygonArray<O>> for GeometryArray<O>

fn from(value: MultiPolygonArray<O>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<PointArray> for GeometryArray<O>

fn from(value: PointArray) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<PolygonArray<O>> for GeometryArray<O>

fn from(value: PolygonArray<O>) -> Self

Converts to this type from the input type.

impl<'a, O: OffsetSizeTrait> GeoArrayAccessor<'a> for GeometryArray<O>

type Item = Geometry<'a, O>

The geoarrow scalar object for this geometry array type.

type ItemGeo = Geometry

The geo scalar object for this geometry array type.

unsafe fn value_unchecked(&'a self, index: usize) -> Self::Item

Returns the element at index i

fn value(&'a self, index: usize) -> Self::Item

Returns the element at index i

fn get(&'a self, index: usize) -> Option<Self::Item>

Access the value at slot i as an Arrow scalar, considering validity.

fn value_as_geo(&'a self, i: usize) -> Self::ItemGeo

Access the value at slot i as a geo scalar, not considering validity.

fn get_as_geo(&'a self, i: usize) -> Option<Self::ItemGeo>

Access the value at slot i as a geo scalar, considering validity.

impl<O: OffsetSizeTrait> GeodesicArea for GeometryArray<O>

fn geodesic_area_signed(&self) -> Float64Array

Determine the area of a geometry on an ellipsoidal model of the earth.

fn geodesic_area_unsigned(&self) -> Float64Array

Determine the area of a geometry on an ellipsoidal model of the earth. Supports very large geometries that cover a significant portion of the earth.

fn geodesic_perimeter(&self) -> Float64Array

Determine the perimeter of a geometry on an ellipsoidal model of the earth.

fn geodesic_perimeter_area_signed(&self) -> (Float64Array, Float64Array)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation.

fn geodesic_perimeter_area_unsigned(&self) -> (Float64Array, Float64Array)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation. Supports very large geometries that cover a significant portion of the earth.

impl<'a, O: OffsetSizeTrait> GeometryArrayTrait<'a> for GeometryArray<O>

fn len(&self) -> usize

The length of the GeometryArray. Every array has a length corresponding to the number of geometries it contains.

fn validity(&self) -> Option<&NullBuffer>

The validity of the GeometryArray: every array has an optional [Bitmap] that, when available specifies whether the geometry at a given slot is valid or not (null). When the validity is None, all slots are valid.

fn slice(&self, offset: usize, length: usize) -> Self

Slices the GeometryArray in place

Implementation

This operation is O(1) over len, as it amounts to increase two ref counts and moving the struct to the heap.

Panic

This function panics iff offset + length > self.len().

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation.

fn data_type(&self) -> &GeoDataType

Returns a reference to the DataType of this array.

fn storage_type(&self) -> DataType

Get the logical DataType of this array.

fn extension_field(&self) -> Arc<Field>

Get the extension type of this array, as defined by the GeoArrow specification.

fn extension_name(&self) -> &str

Get the extension name of this array.

fn into_array_ref(self) -> Arc<dyn Array>

Convert this array into an arced arrow array.

fn with_coords(self, coords: CoordBuffer) -> Self

Create a new array with replaced coordinates

fn coord_type(&self) -> CoordType

Get the coordinate type of this geometry array, either interleaved or separated.

fn into_coord_type(self, coord_type: CoordType) -> Self

Cast the coordinate buffer of this geometry array to the given coordinate type.

fn owned_slice(&self, offset: usize, length: usize) -> Self

A slice that fully copies the contents of the underlying buffer

fn is_empty(&self) -> bool

Returns true if the array is empty.

fn nulls(&self) -> Option<&NullBuffer>

fn logical_nulls(&self) -> Option<NullBuffer>

fn null_count(&self) -> usize

The number of null slots in this array.

fn is_null(&self, i: usize) -> bool

Returns whether slot i is null.

fn is_valid(&self, i: usize) -> bool

Returns whether slot i is valid.

impl<O: OffsetSizeTrait> HasDimensions for GeometryArray<O>

fn is_empty(&self) -> BooleanArray

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

impl<O: OffsetSizeTrait> IntoArrow for GeometryArray<O>

type ArrowArray = Arc<dyn Array>

fn into_arrow(self) -> Self::ArrowArray

impl<O: OffsetSizeTrait> MinimumRotatedRect<i32> for GeometryArray<O>

fn minimum_rotated_rect(&self) -> PolygonArray<i32>

impl<O: OffsetSizeTrait> RemoveRepeatedPoints for GeometryArray<O>

fn remove_repeated_points(&self) -> Self

Create a new geometry with (consecutive) repeated points removed.

impl<O: OffsetSizeTrait> Rotate<PrimitiveArray<Float64Type>> for GeometryArray<O>

fn rotate_around_centroid(&self, degrees: &Float64Array) -> Self

Rotate a geometry around its centroid by an angle, in degrees

fn rotate_around_center(&self, degrees: &Float64Array) -> Self

Rotate a geometry around the center of its bounding box by an angle, in degrees.

fn rotate_around_point(&self, degrees: &Float64Array, point: Point) -> Self

Rotate a Geometry around an arbitrary point by an angle, given in degrees

impl<O: OffsetSizeTrait> Rotate<f64> for GeometryArray<O>

fn rotate_around_centroid(&self, degrees: &f64) -> Self

Rotate a geometry around its centroid by an angle, in degrees

fn rotate_around_center(&self, degrees: &f64) -> Self

Rotate a geometry around the center of its bounding box by an angle, in degrees.

fn rotate_around_point(&self, degrees: &f64, point: Point) -> Self

Rotate a Geometry around an arbitrary point by an angle, given in degrees

impl<O: OffsetSizeTrait> Scale for GeometryArray<O>

fn scale(&self, scale_factor: BroadcastablePrimitive<Float64Type>) -> Self

Scale geometries from its bounding box center.

fn scale_xy( &self, x_factor: BroadcastablePrimitive<Float64Type>, y_factor: BroadcastablePrimitive<Float64Type>, ) -> Self

Scale geometries from its bounding box center, using different values for x_factor and y_factor to distort the geometry’s aspect ratio.

fn scale_around_point( &self, x_factor: BroadcastablePrimitive<Float64Type>, y_factor: BroadcastablePrimitive<Float64Type>, origin: Point, ) -> Self

Scale geometries around a point of origin.

impl<O: OffsetSizeTrait> Simplify for GeometryArray<O>

fn simplify(&self, epsilon: &f64) -> Self

Returns the simplified representation of a geometry, using the Ramer–Douglas–Peucker algorithm

impl<O: OffsetSizeTrait> SimplifyVw for GeometryArray<O>

fn simplify_vw(&self, epsilon: &f64) -> Self

Returns the simplified representation of a geometry, using the Visvalingam-Whyatt algorithm

impl<O: OffsetSizeTrait> Skew for GeometryArray<O>

fn skew(&self, scale_factor: BroadcastablePrimitive<Float64Type>) -> Self

An affine transformation which skews a geometry, sheared by a uniform angle along the x and y dimensions.

fn skew_xy( &self, x_factor: BroadcastablePrimitive<Float64Type>, y_factor: BroadcastablePrimitive<Float64Type>, ) -> Self

An affine transformation which skews a geometry, sheared by an angle along the x and y dimensions.

fn skew_around_point( &self, x_factor: BroadcastablePrimitive<Float64Type>, y_factor: BroadcastablePrimitive<Float64Type>, origin: Point, ) -> Self

An affine transformation which skews a geometry around a point of origin, sheared by an angle along the x and y dimensions.

impl<O: OffsetSizeTrait> Translate for GeometryArray<O>

fn translate( &self, x_offset: BroadcastablePrimitive<Float64Type>, y_offset: BroadcastablePrimitive<Float64Type>, ) -> Self

Translate a Geometry along its axes by the given offsets

impl TryFrom<(&Field, &dyn Array)> for GeometryArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from((field, array): (&Field, &dyn Array)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(&Field, &dyn Array)> for GeometryArray<i64>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from((field, array): (&Field, &dyn Array)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<GeometryArray<i64>> for GeometryArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: GeometryArray<i64>) -> Result<Self, Self::Error>

Performs the conversion.

impl<O: OffsetSizeTrait> TryFrom<WKBArray<O>> for GeometryArray<O>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: WKBArray<O>) -> Result<Self, Self::Error>

Performs the conversion.