Struct geoarrow::array::MixedGeometryArray

pub struct MixedGeometryArray<O: OffsetSizeTrait> { /* private fields */ }

Invariants

• All arrays must have the same dimension
• All arrays must have the same coordinate layout (interleaved or separated)

Implementations

impl<O: OffsetSizeTrait> MixedGeometryArray<O>

pub fn new( type_ids: ScalarBuffer<i8>, offsets: ScalarBuffer<i32>, points: Option<PointArray>, line_strings: Option<LineStringArray<O>>, polygons: Option<PolygonArray<O>>, multi_points: Option<MultiPointArray<O>>, multi_line_strings: Option<MultiLineStringArray<O>>, multi_polygons: Option<MultiPolygonArray<O>>, metadata: Arc<ArrayMetadata> ) -> Self

Create a new MixedGeometryArray from parts

Implementation

This function is O(1).

Panics

• if the validity is not None and its length is different from the number of geometries
• if the largest geometry offset does not match the number of coordinates

pub fn buffer_lengths(&self) -> MixedCapacity

The lengths of each buffer contained in this array.

pub fn has_points(&self) -> bool

pub fn has_line_strings(&self) -> bool

pub fn has_polygons(&self) -> bool

pub fn has_multi_points(&self) -> bool

pub fn has_multi_line_strings(&self) -> bool

pub fn has_multi_polygons(&self) -> bool

pub fn num_bytes(&self) -> usize

The number of bytes occupied by this array.

impl<O: OffsetSizeTrait> MixedGeometryArray<O>

pub fn iter_geo_values(&self) -> impl Iterator<Item = Geometry> + '_

Iterator over geo Geometry objects, not looking at validity

pub fn iter_geo(&self) -> impl Iterator<Item = Option<Geometry>> + '_

Iterator over geo Geometry objects, taking into account validity

pub fn value_as_geos(&self, i: usize) -> Geometry<'_>

Returns the value at slot i as a GEOS geometry.

pub fn get_as_geos(&self, i: usize) -> Option<Geometry<'_>>

Gets the value at slot i as a GEOS geometry, additionally checking the validity bitmap

pub fn iter_geos_values(&self) -> impl Iterator<Item = Geometry<'_>> + '_

Iterator over GEOS geometry objects

pub fn iter_geos(&self) -> impl Iterator<Item = Option<Geometry<'_>>> + '_

Iterator over GEOS geometry objects, taking validity into account

impl<'a, O: OffsetSizeTrait> MixedGeometryArray<O>

pub fn iter(&'a self) -> MixedGeometryArrayIter<'_, O>

Returns an iterator of Option<Geometry>

Trait Implementations

impl<O: OffsetSizeTrait> AffineOps<&[AffineTransform]> for MixedGeometryArray<O>

type Output = MixedGeometryArray<O>

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

Apply transform immutably, outputting a new geometry.

impl<O: OffsetSizeTrait> AffineOps<&AffineTransform> for MixedGeometryArray<O>

type Output = MixedGeometryArray<O>

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

Apply transform immutably, outputting a new geometry.

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

type Output = PrimitiveArray<Float64Type>

fn signed_area(&self) -> Self::Output

fn unsigned_area(&self) -> Self::Output

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

type Output = Result<PrimitiveArray<Float64Type>, GeoArrowError>

fn area(&self) -> Self::Output

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

type Output = RectArray

fn bounding_rect(&self) -> Self::Output

Return the bounding rectangle of a geometry

impl<O: OffsetSizeTrait> Cast for MixedGeometryArray<O>

fn cast(&self, to_type: &GeoDataType) -> Self::Output

TODO: in the future, do more validation before trying to fill all geometries

type Output = Result<Arc<dyn GeometryArrayTrait>, GeoArrowError>

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

type Output = PointArray

fn center(&self) -> Self::Output

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

type Output = PointArray

fn centroid(&self) -> Self::Output

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

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

type Output = PrimitiveArray<Float64Type>

fn chamberlain_duquette_signed_area(&self) -> Self::Output

fn chamberlain_duquette_unsigned_area(&self) -> Self::Output

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: OffsetSizeTrait, O2: OffsetSizeTrait> ConvexHull<O> for MixedGeometryArray<O2>

type Output = PolygonArray<O>

fn convex_hull(&self) -> Self::Output

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

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

Formats the value using the given formatter.

impl<O: OffsetSizeTrait> Default for MixedGeometryArray<O>

Default to an empty array

fn default() -> Self

Returns the “default value” for a type.

impl<O: OffsetSizeTrait> Downcast for MixedGeometryArray<O>

type Output = Arc<dyn GeometryArrayTrait>

fn downcasted_data_type(&self, small_offsets: bool) -> GeoDataType

The data type that downcasting would result in.

fn downcast(&self, small_offsets: bool) -> Self::Output

If possible, convert this array to a simpler and/or smaller data type

impl<A: OffsetSizeTrait, B: OffsetSizeTrait> From<&MixedGeometryArray<A>> for WKBArray<B>

fn from(value: &MixedGeometryArray<A>) -> Self

Converts to this type from the input type.

impl From<MixedGeometryArray<i32>> for MixedGeometryArray<i64>

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

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<MixedGeometryBuilder<O>> for MixedGeometryArray<O>

fn from(other: MixedGeometryBuilder<O>) -> Self

Converts to this type from the input type.

impl<OOutput: OffsetSizeTrait> FromEWKB for MixedGeometryArray<OOutput>

type Input<O: OffsetSizeTrait> = WKBArray<O>

fn from_ewkb<O: OffsetSizeTrait>( arr: &Self::Input<O>, coord_type: CoordType, metadata: Arc<ArrayMetadata>, prefer_multi: bool ) -> Result<Self>

impl<OOutput: OffsetSizeTrait> FromWKB for MixedGeometryArray<OOutput>

type Input<O: OffsetSizeTrait> = WKBArray<O>

fn from_wkb<O: OffsetSizeTrait>( arr: &WKBArray<O>, coord_type: CoordType ) -> Result<Self>

impl<OOutput: OffsetSizeTrait> FromWKT for MixedGeometryArray<OOutput>

type Input<O: OffsetSizeTrait> = GenericByteArray<GenericStringType<O>>

fn from_wkt<O: OffsetSizeTrait>( arr: &Self::Input<O>, coord_type: CoordType, metadata: Arc<ArrayMetadata>, prefer_multi: bool ) -> Result<Self>

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

type OutputSingle = PrimitiveArray<Float64Type>

type OutputDouble = (PrimitiveArray<Float64Type>, PrimitiveArray<Float64Type>)

fn geodesic_perimeter(&self) -> Self::OutputSingle

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

fn geodesic_area_signed(&self) -> Self::OutputSingle

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

fn geodesic_area_unsigned(&self) -> Self::OutputSingle

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_area_signed(&self) -> Self::OutputDouble

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) -> Self::OutputDouble

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> GeometryArrayAccessor<'a> for MixedGeometryArray<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> GeometryArraySelfMethods for MixedGeometryArray<O>

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

Slices this MixedGeometryArray in place.

Implementation

This operation is O(F) where F is the number of fields.

Panic

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

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

Create a new array with replaced coordinates

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

impl<O: OffsetSizeTrait> GeometryArrayTrait for MixedGeometryArray<O>

fn len(&self) -> usize

Returns the number of geometries in this array

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

Returns the optional validity.

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 GeoDataType 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 to_array_ref(&self) -> ArrayRef

fn coord_type(&self) -> CoordType

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

fn metadata(&self) -> Arc<ArrayMetadata>

fn as_ref(&self) -> &dyn GeometryArrayTrait

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> GeozeroGeometry for MixedGeometryArray<O>

fn process_geom<P: GeomProcessor>(&self, processor: &mut P) -> Result<()>

where Self: Sized,

Process geometry.

fn dims(&self) -> CoordDimensions

Dimensions of geometry

fn srid(&self) -> Option<i32>

SRID of geometry

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

type Output = BooleanArray

fn is_empty(&self) -> Self::Output

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

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

type ArrowArray = UnionArray

fn into_arrow(self) -> Self::ArrowArray

impl<O: OffsetSizeTrait> IsRing for MixedGeometryArray<O>

type Output = Result<BooleanArray, GeoArrowError>

fn is_ring(&self) -> Self::Output

impl<O: OffsetSizeTrait> IsValid for MixedGeometryArray<O>

type Output = BooleanArray

fn is_valid(&self) -> Self::Output

impl<OOutput: OffsetSizeTrait, OInput: OffsetSizeTrait> MinimumRotatedRect<OOutput> for MixedGeometryArray<OInput>

type Output = PolygonArray<OOutput>

fn minimum_rotated_rect(&self) -> Self::Output

impl<O: PartialEq + OffsetSizeTrait> PartialEq for MixedGeometryArray<O>

fn eq(&self, other: &MixedGeometryArray<O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, O: OffsetSizeTrait> RTree<'a> for MixedGeometryArray<O>

type RTreeObject = CachedEnvelope<Geometry<'a, O>>

The object type to store in the RTree.

fn rstar_tree(&'a self) -> RTree<Self::RTreeObject>

Build an RTree spatial index containing this array’s geometries.

impl<O: OffsetSizeTrait> Rechunk for MixedGeometryArray<O>

type Output = Result<ChunkedGeometryArray<MixedGeometryArray<O>>, GeoArrowError>

fn rechunk(&self, ranges: &[Range<usize>]) -> Self::Output

impl<O: OffsetSizeTrait> Take for MixedGeometryArray<O>

type Output = Result<MixedGeometryArray<O>, GeoArrowError>

fn take(&self, indices: &UInt32Array) -> Self::Output

fn take_range(&self, range: &Range<usize>) -> Self::Output

impl<O: OffsetSizeTrait, G: GeometryTrait<T = f64>> TryFrom<&[G]> for MixedGeometryArray<O>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(geoms: &[G]) -> Result<Self>

Performs the conversion.

impl<O: OffsetSizeTrait, G: GeometryTrait<T = f64>> TryFrom<&[Option<G>]> for MixedGeometryArray<O>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(geoms: &[Option<G>]) -> Result<Self>

Performs the conversion.

impl TryFrom<&UnionArray> for MixedGeometryArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: &UnionArray) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&UnionArray> for MixedGeometryArray<i64>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: &UnionArray) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&dyn Array> for MixedGeometryArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: &dyn Array) -> Result<Self>

Performs the conversion.

impl TryFrom<&dyn Array> for MixedGeometryArray<i64>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: &dyn Array) -> Result<Self>

Performs the conversion.

impl TryFrom<MixedGeometryArray<i64>> for MixedGeometryArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: MixedGeometryArray<i64>) -> Result<Self>

Performs the conversion.

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

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<O: OffsetSizeTrait> StructuralPartialEq for MixedGeometryArray<O>