1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
project.
Copyright (C) 1998-2018 OpenLink Software
This project is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; only version 2 of the License, dated June 1991.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
$
-->
<refentry id="fn_dist_from_point_to_line_segment">
<refmeta>
<refentrytitle>dist_from_point_to_line_segment</refentrytitle>
<refmiscinfo>geo</refmiscinfo>
</refmeta>
<refnamediv>
<refname>dist_from_point_to_line_segment</refname>
<refpurpose>returns the distance between a point and a segment on a plane.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_dist_from_point_to_line_segment">
<funcprototype id="fproto_dist_from_point_to_line_segment">
<funcdef><function>dist_from_point_to_line_segment</function></funcdef>
<paramdef>in <parameter>Xpoint</parameter> any</paramdef>
<paramdef>in <parameter>Ypoint</parameter> any</paramdef>
<paramdef>in <parameter>Xsegment1</parameter> any</paramdef>
<paramdef>in <parameter>Ysegment1</parameter> any</paramdef>
<paramdef>in <parameter>Xsegment2</parameter> any</paramdef>
<paramdef>in <parameter>Ysegment2</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_dist_from_point_to_line_segment">
<title>Description</title>
<para>returns the distance between a point and a segment on a plane. </para>
</refsect1>
<refsect1 id="params_dist_from_point_to_line_segment">
<title>Parameters</title>
<refsect2><title>Xpoint</title><para>A X point</para></refsect2>
<refsect2><title>Ypoint</title><para>A Y point</para></refsect2>
<refsect2><title>Xsegment1</title><para>X Segment</para></refsect2>
<refsect2><title>Ysegment1</title><para>Y Segment</para></refsect2>
<refsect2><title>Xsegment2</title><para>X Segment</para></refsect2>
<refsect2><title>Ysegment2</title><para>Y Segment</para></refsect2>
</refsect1>
<refsect1 id="ret_dist_from_point_to_line_segment"><title>Return Types</title>
<para>Returns any.</para>
</refsect1>
<refsect1 id="examples_dist_from_point_to_line_segment">
<title>Examples</title>
<example id="ex_dist_from_point_to_line_segment"><title>Simple Use</title>
<screen><![CDATA[
SQL> select dist_from_point_to_line_segment (5, 5, 0, 3, 4, 0)
4.6
SQL> select dist_from_point_to_line_segment (5, 0, 0, 3, 4, 0)
1
SQL> select dist_from_point_to_line_segment (5, -1, 0, 3, 4, 0)
1.414213562373095
SQL> select dist_from_point_to_line_segment (5, -5, 0, 3, 4, 0)
5.099019513592784
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_dist_from_point_to_line_segment">
<title>See Also</title>
<para><link linkend="fn_haversine_deg_km"><function>haversine_deg_km()</function></link></para>
<para><link linkend="fn_st_point"><function>st_point</function></link></para>
<para><link linkend="fn_st_x"><function>st_x</function></link></para>
<para><link linkend="fn_st_y"><function>st_y</function></link></para>
<para><link linkend="fn_ST_Z"><function>ST_Z</function></link></para>
<para><link linkend="fn_st_distance"><function>st_distance</function></link></para>
<para><link linkend="fn_ST_SetSRID"><function>ST_SetSRID</function></link></para>
<para><link linkend="fn_st_astext"><function>st_astext</function></link></para>
<para><link linkend="fn_st_geomfromtext"><function>st_geomfromtext</function></link></para>
<para><link linkend="fn_st_intersects"><function>st_intersects</function></link></para>
<para><link linkend="fn_st_contains"><function>st_contains</function></link></para>
<para><link linkend="fn_st_within"><function>st_within</function></link></para>
<para><link linkend="fn_isgeometry"><function>isgeometry</function></link></para>
<para><link linkend="fn_geo_insert"><function>geo_insert</function></link></para>
<para><link linkend="fn_geo_delete"><function>geo_delete</function></link></para>
<para><link linkend="fn_rdf_geo_add"><function>DB.DBA.RDF_GEO_ADD</function></link></para>
<para><link linkend="fn_rdf_geo_fill"><function>DB.DBA.RDF_GEO_FILL</function></link></para>
</refsect1>
</refentry>
|
