EasyGeometry::D2::Vector

A vector in a 2-dimensional Euclidean space.

#==(vector)

Description

Compare self and other Vector. Return False unless vector is aEasyGeometry::D2::Vector .

Signature

Parameters:
    vector - EasyGeometry::D2::Vector

Returns:
    boolean (true or false)
    
Errors:

Example

v1 = EasyGeometry::D2::Vector.new(0, 0)
v2 = EasyGeometry::D2::Vector.new(1, 1)

v1 == v1  # true
v2 == v1  # false

#-(vector)

Description

Subtraction of two vectors.

Signature

Parameters:
    vector - EasyGeometry::D2::Vector

Returns:
    EasyGeometry::D2::Vector
    
Errors:
    raise TypeError if point is not a Vector

Example

v1 = EasyGeometry::D2::Vector.new(0, 0)
v2 = EasyGeometry::D2::Vector.new(1, 1)

v1 - v2  # Vector(-1, -1)

#orthogonal_direction

Description

Returns a non-zero vector that is orthogonal to the line containing self and the origin.

Signature

Parameters:

Returns:
    EasyGeometry::D2::Vector
    
Errors:

Example

v1 = EasyGeometry::D2::Vector.new(0, 0)
v2 = EasyGeometry::D2::Vector.new(1, 1)

v1.orthogonal_direction  # Vector(1, 0)
v2.orthogonal_direction  # Vector(-1, 1)

#cross_product(vector)

Description

It is positive if other vector should be turned counter-clockwise in order to superpose them.

It is negative if other vector should be turned clockwise in order to superpose them.

It is zero when vectors are collinear.

Signature

Parameters:
    vector - EasyGeometry::D2::Vector
    
Returns:
    Numeric
    
Errors:
    raise TypeError if point is not a Vector

Example

v1 = EasyGeometry::D2::Vector.new(0, 0)
v2 = EasyGeometry::D2::Vector.new(1, 1)

v1.cross_product(v2)  # 0

#dot(vector)

Description

Dot product, also known as inner product or scalar product.

Signature

Parameters:
    vector - EasyGeometry::D2::Vector

Returns:
    Numeric
    
Errors:
    raise TypeError if point is not a Vector

Example

v1 = EasyGeometry::D2::Vector.new(0, 0)
v2 = EasyGeometry::D2::Vector.new(1, 1)
v3 = EasyGeometry::D2::Vector.new(2, 2)

v1.dot(v2)  # 0
v2.dot(v4)  # 4

#to_point

Description

Converts the vector to a point.

Signature

Parameters:

Returns:
    EasyGeometry::D2::Point
    
Errors:

Example

v1 = EasyGeometry::D2::Vector.new(0, 0)

v1.to_point  # Point(0, 0)