package
0.53.0
Repository: https://github.com/peterstace/simplefeatures.git
Documentation: pkg.go.dev

# Functions

Contains returns true if and only if geometry A contains geometry B.
CoveredBy returns true if and only if geometry A is covered by geometry B.
Covers returns true if and only if geometry A covers geometry B.
Crosses returns true if and only if geometry A and B cross each other.
Difference returns a geometry that represents the parts of input geometry A that are not part of input geometry B.
Disjoint returns true if and only if the input geometries have no points in common.
Distance calculates the shortest distance (using the Euclidean metric) between two geometries.
Equals returns true if and only if the input geometries are spatially equal, i.e.
ExactEquals checks if two geometries are equal from a structural pointwise equality perspective.
IgnoreOrder is an ExactEqualsOption that modifies the behaviour of the ExactEquals method by ignoring ordering that doesn't have a material impact on geometries.
Intersection returns a geometry that represents the parts that are common to both geometry A and geometry B.
Intersects return true if and only the two geometries intersect with each other, i.e.
MarshalTWKB accepts a geometry and generates the corresponding TWKB byte slice.
NewEmptyPoint creates a Point that is empty.
NewEnvelope returns the smallest envelope that contains all provided XYs.
NewGeometryCollection creates a collection of geometries.
NewInterval returns a new non-empty Interval with the given bounds (which may be the same).
NewLineString creates a new LineString from a Sequence of points.
NewLineStringXY builds a new XY LineString from its x and y coordinates, x1, y1, x2, y2, ..., xn, yn.
NewLineStringXYM builds a new XYM LineString from its x, y and m coordinates, x1, y1, m1, x2, y2, m2, ..., xn, yn, mn.
NewLineStringXYZ builds a new XYZ LineString from its x, y and z coordinates, x1, y1, z1, x2, y2, z2, ..., xn, yn, zn.
NewLineStringXYZM builds a new XYZM LineString from its x, y, z and m coordinates, x1, y1, z1, m1, x2, y2, z2, m2, ..., xn, yn, zn, mn.
NewMultiLineString creates a MultiLineString from its constituent LineStrings.
NewMultiLineStringXY builds a new XY MultiLineString from the x and y coordinates of its LineStrings, each in its own slice, in the form x1, y1, x2, y2, ..., xn, yn.
NewMultiLineStringXYM builds a new XYM MultiLineString from the x, y and m coordinates of its LineStrings, each in its own slice, in the form x1, y1, m1, x2, y2, m2, ..., xn, yn, mn.
NewMultiLineStringXYZ builds a new XYZ MultiLineString from the x, y and z coordinates of its LineStrings, each in its own slice, in the form x1, y1, z1, x2, y2, z2, ..., xn, yn, zn.
NewMultiLineStringXYZM builds a new XYZM MultiLineString from the x, y, z and m coordinates of its LineStrings, each in its own slice, in the form x1, y1, z1, m1, x2, y2, z2, m2, ..., xn, yn, zn, mn.
NewMultiPoint creates a MultiPoint from a list of Points.
NewMultiPointXY builds a new XY MultiPoint from its x and y coordinates, x1, y1, x2, y2, ..., xn, yn.
NewMultiPointXYM builds a new XYM MultiPoint from its x, y and m coordinates, x1, y1, m1, x2, y2, m2, ..., xn, yn, mn.
NewMultiPointXYZ builds a new XYZ MultiPoint from its x, y and z coordinates, x1, y1, z1, x2, y2, z2, ..., xn, yn, zn.
NewMultiPointXYZM builds a new XYZM MultiPoint from its x, y, z and m coordinates, x1, y1, z1, m1, x2, y2, z2, m2, ..., xn, yn, zn, mn.
NewMultiPolygon creates a MultiPolygon from its constituent Polygons.
NewMultiPolygonXY builds a new XY MultiPolygon from the x and y coordinates of its Polygons, each in its own slice of rings.
NewMultiPolygonXYM builds a new XYM MultiPolygon from the x, y and m coordinates of its Polygons, each in its own slice of rings.
NewMultiPolygonXYZ builds a new XYZ MultiPolygon from the x, y and z coordinates of its Polygons, each in its own slice of rings.
NewMultiPolygonXYZM builds a new XYZM MultiPolygon from the x, y, z and m coordinates of its Polygons, each in its own slice of rings.
NewPoint creates a new point given its Coordinates.
NewPointXY builds a new XY Point from its x and y coordinates.
NewPointXYM builds a new XYM Point from its x, y and m coordinates.
NewPointXYZ builds new XYZ Point from its x, y and z coordinates.
NewPointXYZM builds a new XYZM Point from its x, y, z and m coordinates.
NewPolygon creates a polygon given its rings.
NewPolygonXY builds a new XY Polygon from the x and y coordinates of its rings, each in its own slice, in the form x1, y1, x2, y2, ..., xn, yn, x1, y1 (the first and last coordinates of each ring should be the same).
NewPolygonXYM builds a new XYM Polygon from the x, y and m coordinates of its rings, each in its own slice, in the form x1, y1, m1, x2, y2, m2, ..., xn, yn, mn, x1, y1, m1 (the first and last coordinates of each ring should be the same).
NewPolygonXYZ builds a new XYZ Polygon from the x, y and z coordinates of its rings, each in its own slice, in the form x1, y1, z1, x2, y2, z2, ..., xn, yn, zn, x1, y1, z1 (the first and last coordinates of each ring should be the same).
NewPolygonXYZM builds a new XYZM Polygon from the x, y, z and m coordinates of its rings, each in its own slice, in the form x1, y1, z1, m1, x2, y2, z2, m2, ..., xn, yn, zn, mn, x1, y1, z1, m1 (the first and last coordinates of each ring should be the same).
NewSequence creates a new Sequence from a raw slice of float64 coordinates.
NewSingleRingPolygonXY builds a new XY Polygon from the x and y coordinates of its exterior ring, in the form x1, y1, x2, y2, ..., xn, yn, x1, y1 (the first and last coordinates of the ring should be the same).
NewSingleRingPolygonXYM builds a new XYM Polygon from the x, y and m coordinates of its exterior ring, in the form x1, y1, m1, x2, y2, m2, ..., xn, yn, mn, x1, y1, m1 (the first and last coordinates of the ring should be the same).
NewSingleRingPolygonXYZ builds a new XYZ Polygon from the x, y and z coordinates of its exterior ring, in the form x1, y1, z1, x2, y2, z2, ..., xn, yn, zn, x1, y1, z1 (the first and last coordinates of the ring should be the same).
NewSingleRingPolygonXYZM builds a new XYZM Polygon from the x, y, z and m coordinates of its exterior ring, in the form x1, y1, z1, m1, x2, y2, z2, m2, ..., xn, yn, zn, mn, x1, y1, z1, m1 (the first and last coordinates of the ring should be the same).
Overlaps returns true if and only if geometry A and B overlap with each other.
Relate calculates the DE-9IM matrix between two geometries, describing how the two geometries relate to each other.
RelateMatches checks to see if an intersection matrix matches against an intersection matrix pattern.
RotatedMinimumAreaBoundingRectangle finds a rectangle with minimum area that fully encloses the geometry.
RotatedMinimumWidthBoundingRectangle finds a rectangle with minimum width that fully encloses the geometry.
SignedArea alters the behaviour of area calculations.
SymmetricDifference returns a geometry that represents the parts of geometry A and B that are not in common.
ToleranceXY modifies the behaviour of the ExactEquals method by allowing two geometry control points be considered equal if their XY coordinates are within the given euclidean distance of each other.
Touches returns true if and only if the geometries have at least 1 point in common, but their interiors don't intersect.
TWKBBoundingBoxHeader causes the writer to output a bounding box header.
TWKBCloseRings causes the writer to close all polygon rings by outputting the first point again as the final point.
TWKBIDList specifies an ID list to be output as a header.
TWKBPrecisionM sets the M precision to between 0 and 7 inclusive.
TWKBPrecisionZ sets the Z precision to between 0 and 7 inclusive.
TWKBSizeHeader causes the writer to output a byte size header.
UnaryUnion is a single input variant of the Union function, unioning together the components of the input geometry.
Union returns a geometry that represents the parts from either geometry A or geometry B (or both).
UnionMany unions together the input geometries.
UnmarshalGeoJSON unmarshals a geometry that is encoded as a GeoJSON Geometry Object.
UnmarshalTWKB parses a Tiny Well Known Binary (TWKB), returning the corresponding Geometry.
UnmarshalTWKBEnvelope parses just the envelope from the header of a Tiny Well Known Binary (TWKB).
UnmarshalTWKBIDList parses just the ID list of a Tiny Well Known Binary (TWKB).
UnmarshalTWKBSize parses the size (in bytes) of the Tiny Well Known Binary (TWKB) from its header.
UnmarshalWKB reads the Well Known Binary (WKB), and returns the corresponding Geometry.
UnmarshalWKT parses a Well Known Text (WKT), and returns the corresponding Geometry.
Within returns true if and only if geometry A is completely within geometry B.
WithTransform alters the behaviour of area calculations by first transforming the geometry with the provided transform function.

# Constants

DimXY coordinates only contain X and Y values.
DimXYM coordinates contain X, Y, and M (measure) values.
DimXYZ coordinates contain X, Y, and Z (height) values.
DimXYZM coordinates contain X, Y, Z (height), and M (measure) values.
TypeGeometryCollection is the type of a GeometryCollection.
TypeLineString is the type of a LineString.
TypeMultiLineString is the type of a MultiLineString.
TypeMultiPoint is the type of a MultiPoint.
TypeMultiPolygon is the type of a MultiPolygon.
TypePoint is the type of a Point.
TypePolygon is the type of a Polygon.

# Structs

Coordinates represents a point location.
Envelope is a generalised axis-aligned rectangle (also known as an Axis Aligned Bounding Box or Minimum Bounding Rectangle).
ExtendedEnvelope is an Envelope that may also contain Z and M ranges.
GeoJSONFeature represents a Geometry with associated free-form properties.
Geometry is a single geometry of any type.
GeometryCollection is a non-homogeneous collection of geometries.
Interval represents the interval bound by two float64 values.
LineString is a linear geometry defined by linear interpolation between a finite set of points.
MultiLineString is a linear geometry that consists of a collection of LineStrings.
MultiPoint is a 0-dimensional geometry that is a collection of points.
MultiPolygon is a planar surface geometry that consists of a collection of (possibly empty) Polygons.
NoValidate causes functions to skip geometry constraint validation.
NullGeometry represents a Geometry that may be NULL.
Point is a zero dimensional geometry that represents a single location in a coordinate space.
Polygon is a planar surface geometry.
Sequence represents a list of point locations.
XY represents a pair of X and Y coordinates.

# Type aliases

AreaOption allows the behaviour of area calculations to be modified.
CoordinatesType controls the dimensionality and type of data used to encode a point location.
ExactEqualsOption allows the behaviour of the ExactEquals method in the Geometry interface to be modified.
GeoJSONFeatureCollection is a collection of GeoJSONFeatures.
GeometryType represents one of the 7 geometry types.
TWKBWriterOption allows setting of optional encoding parameters.