Documentation
¶
Overview ¶
Copyright 2025 César Nieto Sánchez
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- type Euclid2D
- func (g Euclid2D) CrossProduct(v1, v2 *primitives.Vector) *primitives.Vector
- func (g Euclid2D) CrossProductNorm(v1, v2 *primitives.Vector) float64
- func (g Euclid2D) Dimension() int
- func (g Euclid2D) DistancePointLine(point *primitives.Point, line *primitives.Line) float64
- func (g Euclid2D) DoubleAreaTriangle(point *primitives.Point, line *primitives.Line) float64
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Euclid2D ¶
type Euclid2D struct {
}
Euclid2D represents a 2D geometric system. It provides the necessary methods to perform 2D geometric operations such as cross product and distance calculations.
func NewEuclid ¶
func NewEuclid() Euclid2D
NewEuclid creates and returns a new instance of Euclid2D.
Returns:
- Euclid2D: A new instance of the 2D geometry system.
func (Euclid2D) CrossProduct ¶
func (g Euclid2D) CrossProduct(v1, v2 *primitives.Vector) *primitives.Vector
CrossProduct computes the cross product of two 2D vectors and returns the result as a 3D vector. The Z-component of the resulting 3D vector represents the scalar cross product of the 2D vectors.
Parameters:
- v1 (*primitives.Vector): The first 2D vector to be used in the cross product.
- v2 (*primitives.Vector): The second 2D vector to be used in the cross product.
Returns:
- *geom3d.Vector3D: A 3D vector where the Z-component represents the cross product of the input 2D vectors.
func (Euclid2D) CrossProductNorm ¶
func (g Euclid2D) CrossProductNorm(v1, v2 *primitives.Vector) float64
CrossProductNorm computes the magnitude (norm) of the cross product of two 2D vectors. This magnitude corresponds to the area of the parallelogram formed by the vectors.
Parameters:
- v1 (*primitives.Vector): The first 2D vector.
- v2 (*primitives.Vector): The second 2D vector.
Returns:
- float64: The magnitude (norm) of the cross product.
func (Euclid2D) Dimension ¶
Dimension returns the dimension of the geometry system.
Returns:
- int: The dimension of the geometry, which is always 2 for this system.
func (Euclid2D) DistancePointLine ¶
func (g Euclid2D) DistancePointLine(point *primitives.Point, line *primitives.Line) float64
DistancePointLine computes the shortest distance from a point to a line. It divides the double area of the triangle formed by the point and the line by the norm of the line's direction vector.
Parameters:
- point (*Point2D): The point whose distance to the line is being calculated.
- line (*Line2D): The line to which the distance is being measured.
Returns:
- float64: The shortest distance from the point to the line.
func (Euclid2D) DoubleAreaTriangle ¶
func (g Euclid2D) DoubleAreaTriangle(point *primitives.Point, line *primitives.Line) float64
DoubleAreaTriangle calculates the double of the area of a triangle formed by a point and a line. The area is computed using the cross product of the vector from the point to one line endpoint and the line's direction vector.
Parameters:
- point (*Point2D): The point used to form the triangle.
- line (*Line2D): The line forming the base of the triangle.
Returns:
- float64: The double of the triangle's area.
Source Files