Enum CoordBuffer 

pub enum CoordBuffer {
    Interleaved(InterleavedCoordBuffer),
    Separated(SeparatedCoordBuffer),
}

An Arrow representation of an array of coordinates.

As defined in the GeoArrow spec, coordinates can either be interleaved (i.e. a single array of XYXYXY) or separated (i.e. two arrays, one XXX and another YYY).

This CoordBuffer abstracts over an InterleavedCoordBuffer and a SeparatedCoordBuffer.

For now all coordinate buffers support only two dimensions.

This is named CoordBuffer instead of CoordArray because the buffer does not store its own validity bitmask. Rather the geometry arrays that build on top of this maintain their own validity masks.

Variants

Interleaved(InterleavedCoordBuffer)

Interleaved coordinates

Separated(SeparatedCoordBuffer)

Separated coordinates

Implementations

impl CoordBuffer

pub fn coord_type(&self) -> CoordType

The underlying coordinate type

pub fn len(&self) -> usize

The length of this coordinate buffer

pub fn is_empty(&self) -> bool

Whether this coordinate buffer is empty

pub fn value(&self, index: usize) -> Coord<'_>

Returns the element at index i, not considering validity.

Examples

use geo_traits::CoordTrait;
use geoarrow_array::array::{CoordBuffer, SeparatedCoordBuffer};
use geoarrow_schema::Dimension;

let coords = [
    geo_types::coord! { x: 1.0, y: 2.0 },
    geo_types::coord! { x: 3.0, y: 4.0 },
];
let coord_buffer = CoordBuffer::from(
    SeparatedCoordBuffer::from_coords(coords.iter(), Dimension::XY).unwrap()
);
let coord = coord_buffer.value(0);
assert_eq!(coord.x(), 1.0);
assert_eq!(coord.y(), 2.0);

Panics

Panics if the value is outside the bounds of the buffer.

pub unsafe fn value_unchecked(&self, index: usize) -> Coord<'_>

Returns the element at index i, not considering validity.

Examples

use geo_traits::CoordTrait;
use geoarrow_array::array::{CoordBuffer, SeparatedCoordBuffer};
use geoarrow_schema::Dimension;

let coords = [
    geo_types::coord! { x: 1.0, y: 2.0 },
    geo_types::coord! { x: 3.0, y: 4.0 },
];
let coord_buffer = CoordBuffer::from(
    SeparatedCoordBuffer::from_coords(coords.iter(), Dimension::XY).unwrap()
);
let coord = unsafe { coord_buffer.value_unchecked(0) };
assert_eq!(coord.x(), 1.0);
assert_eq!(coord.y(), 2.0);

Safety

Caller is responsible for ensuring that the index is within the bounds of the buffer.

pub fn dim(&self) -> Dimension

The dimension of this coordinate buffer

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

Convert this coordinate array into the given CoordType

This is a no-op if the coord_type matches the existing coord type. Otherwise a full clone of the underlying coordinate buffers will be performed.

Trait Implementations

impl Clone for CoordBuffer

fn clone(&self) -> CoordBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoordBuffer

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

Formats the value using the given formatter.

impl From<CoordBuffer> for ArrayRef

fn from(value: CoordBuffer) -> Self

Converts to this type from the input type.

impl From<InterleavedCoordBuffer> for CoordBuffer

fn from(value: InterleavedCoordBuffer) -> Self

Converts to this type from the input type.

impl From<SeparatedCoordBuffer> for CoordBuffer

fn from(value: SeparatedCoordBuffer) -> Self

Converts to this type from the input type.

impl PartialEq for CoordBuffer

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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