From c0f44db314eeafdae943580f5e8c44bcffb28920 Mon Sep 17 00:00:00 2001 From: Regina Obe Date: Sun, 7 Dec 2008 02:29:22 +0000 Subject: [PATCH] Move over (x,y,z) min/max family and add cross reference to those from ST_X, ST_Y, ST_Z git-svn-id: http://svn.osgeo.org/postgis/trunk@3367 b70326c6-7e19-0410-871a-916f4a2858ee --- doc/reference.xml | 16 -- doc/reference_new.xml | 477 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 474 insertions(+), 19 deletions(-) diff --git a/doc/reference.xml b/doc/reference.xml index cab2947af..4ebdb2b80 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -454,22 +454,6 @@ circle. Returns false otherwise. - - - ST_XMin(box3d) ST_YMin(box3d) ST_ZMin(box3d) - - - Returns the requested minima of a bounding box. - - - - - ST_XMax(box3d) ST_YMax(box3d) ST_ZMax(box3d) - - - Returns the requested maxima of a bounding box. - - diff --git a/doc/reference_new.xml b/doc/reference_new.xml index e8857bf8b..504c0e927 100644 --- a/doc/reference_new.xml +++ b/doc/reference_new.xml @@ -4210,6 +4210,8 @@ Line[ZB] with 2 points : Polygon[ZB] with 1 rings Return the X coordinate of the point, or NULL if not available. Input must be a point. + + If you want to get the max min x values of any geometry look at ST_XMin, ST_XMax functions. @@ -4258,7 +4260,7 @@ SELECT ST_Y(ST_Centroid(ST_GeomFromEWKT('LINESTRING(1 2 3 4, 1 1 1 1)'))); See Also - , , , , + , , , , , , @@ -4333,7 +4335,7 @@ SELECT ST_Y(ST_Centroid(ST_GeomFromEWKT('LINESTRING(1 2 3 4, 1 1 1 1)'))); See Also - , , , , + , , , , , , @@ -4394,7 +4396,7 @@ SELECT ST_Y(ST_Centroid(ST_GeomFromEWKT('LINESTRING(1 2 3 4, 1 1 1 1)'))); See Also - , , , + , , , , , @@ -12009,6 +12011,475 @@ fulltable_size geomsize pergeom + + + + ST_XMax + + Returns x maxima of a bounding box 2d or 3d or a geometry. + + + + + + float ST_XMax + box3d aGeomorBox2DorBox3D + + + + + + Description + + Returns X maxima of a bounding box 2d or 3d or a geometry. + + + Although this function is only defined for box3d, it will work for box2d and geometry because of the auto-casting behavior + defined for geometries and box2d. However you can not feed it a geometry or box2d text represenation, since that will not auto-cast. + + + + + + + + This function supports 3d and will not drop the z-index. + + + + + + This method supports Circular Strings and curves + + + + + Examples + + SELECT ST_XMax('BOX3D(1 2 3, 4 5 6)'); +st_xmax +------- +4 + +SELECT ST_XMax(ST_GeomFromText('LINESTRING(1 3 4, 5 6 7)')); +st_xmax +------- +5 + +SELECT ST_XMax(CAST('BOX(-3 2, 3 4)' As box2d)); +st_xmax +------- +3 +--Observe THIS DOES NOT WORK because it will try to autocast the string representation to a BOX3D +SELECT ST_XMax('LINESTRING(1 3, 5 6)'); + +--ERROR: BOX3D parser - doesnt start with BOX3D( + +SELECT ST_XMax(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)')); +st_xmax +-------- +220288.248780547 + + + + + + See Also + + , , , , + + + + + + ST_XMin + + Returns x minima of a bounding box 2d or 3d or a geometry. + + + + + + float ST_XMin + box3d aGeomorBox2DorBox3D + + + + + + Description + + Returns X minima of a bounding box 2d or 3d or a geometry. + + + Although this function is only defined for box3d, it will work for box2d and geometry because of the auto-casting behavior + defined for geometries and box2d. However you can not feed it a geometry or box2d text represenation, since that will not auto-cast. + + + + + + + + This function supports 3d and will not drop the z-index. + + + + + + This method supports Circular Strings and curves + + + + + Examples + + SELECT ST_XMin('BOX3D(1 2 3, 4 5 6)'); +st_xmin +------- +1 + +SELECT ST_XMin(ST_GeomFromText('LINESTRING(1 3 4, 5 6 7)')); +st_xmin +------- +1 + +SELECT ST_XMin(CAST('BOX(-3 2, 3 4)' As box2d)); +st_xmin +------- +-3 +--Observe THIS DOES NOT WORK because it will try to autocast the string representation to a BOX3D +SELECT ST_XMin('LINESTRING(1 3, 5 6)'); + +--ERROR: BOX3D parser - doesnt start with BOX3D( + +SELECT ST_XMin(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)')); +st_xmin +-------- +220186.995121892 + + + + + + See Also + + , , , , + + + + + + ST_YMax + + Returns Y maxima of a bounding box 2d or 3d or a geometry. + + + + + + float ST_YMax + box3d aGeomorBox2DorBox3D + + + + + + Description + + Returns Y maxima of a bounding box 2d or 3d or a geometry. + + + Although this function is only defined for box3d, it will work for box2d and geometry because of the auto-casting behavior + defined for geometries and box2d. However you can not feed it a geometry or box2d text represenation, since that will not auto-cast. + + + + + + + + This function supports 3d and will not drop the z-index. + + + + + + This method supports Circular Strings and curves + + + + + Examples + + SELECT ST_YMax('BOX3D(1 2 3, 4 5 6)'); +st_ymax +------- +5 + +SELECT ST_YMax(ST_GeomFromText('LINESTRING(1 3 4, 5 6 7)')); +st_ymax +------- +6 + +SELECT ST_YMax(CAST('BOX(-3 2, 3 4)' As box2d)); +st_ymax +------- +4 +--Observe THIS DOES NOT WORK because it will try to autocast the string representation to a BOX3D +SELECT ST_YMax('LINESTRING(1 3, 5 6)'); + +--ERROR: BOX3D parser - doesnt start with BOX3D( + +SELECT ST_YMax(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)')); +st_ymax +-------- +150506.126829327 + + + + + + See Also + + , , , , + + + + + + ST_YMin + + Returns Y minima of a bounding box 2d or 3d or a geometry. + + + + + + float ST_YMin + box3d aGeomorBox2DorBox3D + + + + + + Description + + Returns Y minima of a bounding box 2d or 3d or a geometry. + + + Although this function is only defined for box3d, it will work for box2d and geometry because of the auto-casting behavior + defined for geometries and box2d. However you can not feed it a geometry or box2d text represenation, since that will not auto-cast. + + + + + + + + This function supports 3d and will not drop the z-index. + + + + + + This method supports Circular Strings and curves + + + + + Examples + + SELECT ST_YMin('BOX3D(1 2 3, 4 5 6)'); +st_ymin +------- +2 + +SELECT ST_YMin(ST_GeomFromText('LINESTRING(1 3 4, 5 6 7)')); +st_ymin +------- +3 + +SELECT ST_YMin(CAST('BOX(-3 2, 3 4)' As box2d)); +st_ymin +------- +2 +--Observe THIS DOES NOT WORK because it will try to autocast the string representation to a BOX3D +SELECT ST_YMin('LINESTRING(1 3, 5 6)'); + +--ERROR: BOX3D parser - doesnt start with BOX3D( + +SELECT ST_YMin(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)')); +st_ymin +-------- +150406 + + + + + + See Also + + , , , , , + + + + + + ST_ZMax + + Returns Z minima of a bounding box 2d or 3d or a geometry. + + + + + + float ST_ZMax + box3d aGeomorBox2DorBox3D + + + + + + Description + + Returns Z minima of a bounding box 2d or 3d or a geometry. + + + Although this function is only defined for box3d, it will work for box2d and geometry because of the auto-casting behavior + defined for geometries and box2d. However you can not feed it a geometry or box2d text represenation, since that will not auto-cast. + + + + + + + + This function supports 3d and will not drop the z-index. + + + + + + This method supports Circular Strings and curves + + + + + Examples + + SELECT ST_ZMax('BOX3D(1 2 3, 4 5 6)'); +st_zmax +------- +6 + +SELECT ST_ZMax(ST_GeomFromEWKT('LINESTRING(1 3 4, 5 6 7)')); +st_zmax +------- +7 + +SELECT ST_ZMax('BOX3D(-3 2 1, 3 4 1)' ); +st_zmax +------- +1 +--Observe THIS DOES NOT WORK because it will try to autocast the string representation to a BOX3D +SELECT ST_ZMax('LINESTRING(1 3 4, 5 6 7)'); + +--ERROR: BOX3D parser - doesnt start with BOX3D( + +SELECT ST_ZMax(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)')); +st_zmax +-------- +3 + + + + + + See Also + + , , , , , + + + + + + ST_ZMin + + Returns Z minima of a bounding box 2d or 3d or a geometry. + + + + + + float ST_ZMin + box3d aGeomorBox2DorBox3D + + + + + + Description + + Returns Z minima of a bounding box 2d or 3d or a geometry. + + + Although this function is only defined for box3d, it will work for box2d and geometry because of the auto-casting behavior + defined for geometries and box2d. However you can not feed it a geometry or box2d text represenation, since that will not auto-cast. + + + + + + + + This function supports 3d and will not drop the z-index. + + + + + + This method supports Circular Strings and curves + + + + + Examples + + SELECT ST_ZMin('BOX3D(1 2 3, 4 5 6)'); +st_zmin +------- +3 + +SELECT ST_ZMin(ST_GeomFromEWKT('LINESTRING(1 3 4, 5 6 7)')); +st_zmin +------- +4 + +SELECT ST_ZMin('BOX3D(-3 2 1, 3 4 1)' ); +st_zmin +------- +1 +--Observe THIS DOES NOT WORK because it will try to autocast the string representation to a BOX3D +SELECT ST_ZMin('LINESTRING(1 3 4, 5 6 7)'); + +--ERROR: BOX3D parser - doesnt start with BOX3D( + +SELECT ST_ZMin(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)')); +st_zmin +-------- +1 + + + + + + See Also + + , , , , , , + + + -- 2.50.0