C# Class Accord.Point

Show file Open project: accord-net/framework Class Usage Examples

Public Properties

Property Type Description
X float
Y float

Public Methods

Method Description
Add ( Point point1, Point point2 ) : Point

Addition operator - adds values of two points.

Add ( Point point, float valueToAdd ) : Point

Addition operator - adds scalar to the specified point.

DistanceTo ( Point anotherPoint ) : float

Calculate Euclidean distance between two points.

Divide ( Point point, float factor ) : Point

Division operator - divides coordinates of the specified point by scalar value.

Equals ( object obj ) : bool

Check if this instance of Point equal to the specified one.

EuclideanNorm ( ) : float

Calculate Euclidean norm of the vector comprised of the point's coordinates - distance from (0, 0) in other words.

GetHashCode ( ) : int

Get hash code for this instance.

Multiply ( Point point, float factor ) : Point

Multiplication operator - multiplies coordinates of the specified point by scalar value.

Point ( float x, float y ) : System

Initializes a new instance of the Point structure.

Round ( ) : IntPoint

Rounds the single precision point.

SquaredDistanceTo ( Point anotherPoint ) : float

Calculate squared Euclidean distance between two points.

Subtract ( Point point1, Point point2 ) : Point

Subtraction operator - subtracts values of two points.

Subtract ( Point point, float valueToSubtract ) : Point

Subtraction operator - subtracts scalar from the specified point.

ToString ( ) : string

Get string representation of the class.

operator ( ) : Point

Addition operator - adds values of two points.

operator ( ) : bool

Equality operator - checks if two points have equal coordinates.

Method Details

Add() public static method

Addition operator - adds values of two points.
public static Add ( Point point1, Point point2 ) : Point
point1 Point First point for addition.
point2 Point Second point for addition.
return Point

Add() public static method

Addition operator - adds scalar to the specified point.
public static Add ( Point point, float valueToAdd ) : Point
point Point Point to increase coordinates of.
valueToAdd float Value to add to coordinates of the specified point.
return Point

DistanceTo() public method

Calculate Euclidean distance between two points.
public DistanceTo ( Point anotherPoint ) : float
anotherPoint Point Point to calculate distance to.
return float

Divide() public static method

Division operator - divides coordinates of the specified point by scalar value.
public static Divide ( Point point, float factor ) : Point
point Point Point to divide coordinates of.
factor float Division factor.
return Point

Equals() public method

Check if this instance of Point equal to the specified one.
public Equals ( object obj ) : bool
obj object Another point to check equalty to.
return bool

EuclideanNorm() public method

Calculate Euclidean norm of the vector comprised of the point's coordinates - distance from (0, 0) in other words.
public EuclideanNorm ( ) : float
return float

GetHashCode() public method

Get hash code for this instance.
public GetHashCode ( ) : int
return int

Multiply() public static method

Multiplication operator - multiplies coordinates of the specified point by scalar value.
public static Multiply ( Point point, float factor ) : Point
point Point Point to multiply coordinates of.
factor float Multiplication factor.
return Point

Point() public method

Initializes a new instance of the Point structure.
public Point ( float x, float y ) : System
x float X axis coordinate.
y float Y axis coordinate.
return System

Round() public method

Rounds the single precision point.
public Round ( ) : IntPoint
return IntPoint

SquaredDistanceTo() public method

Calculate squared Euclidean distance between two points.
public SquaredDistanceTo ( Point anotherPoint ) : float
anotherPoint Point Point to calculate distance to.
return float

Subtract() public static method

Subtraction operator - subtracts values of two points.
public static Subtract ( Point point1, Point point2 ) : Point
point1 Point Point to subtract from.
point2 Point Point to subtract.
return Point

Subtract() public static method

Subtraction operator - subtracts scalar from the specified point.
public static Subtract ( Point point, float valueToSubtract ) : Point
point Point Point to decrease coordinates of.
valueToSubtract float Value to subtract from coordinates of the specified point.
return Point

ToString() public method

Get string representation of the class.
public ToString ( ) : string
return string

operator() public static method

Addition operator - adds values of two points.
public static operator ( ) : Point
return Point

operator() public static method

Equality operator - checks if two points have equal coordinates.
public static operator ( ) : bool
return bool

Property Details

X public property

X coordinate.
public float X
return float

Y public property

Y coordinate.
public float Y
return float