zhao.algorithmMagic.operands.coordinate.DoubleCoordinateTwo Maven / Gradle / Ivy
package zhao.algorithmMagic.operands.coordinate;
/**
* Java类于 2022/10/10 09:35:09 创建
*
* Double类型的二维坐标，该坐标点的每一个坐标轴数值都是double类型，该坐标点是一个final，如果您需要实现一个属于您自己的坐标，您可以实现"FloatingPointCoordinates"接口。
*
* Two-dimensional coordinates of type Double, each axis value of the coordinate point is of type double, the coordinate point is a final, if you need to implement a coordinate of your own, you can implement the "Floating Point Coordinates" interface.
*
* @author zhao
*/
public final class DoubleCoordinateTwo implements FloatingPointCoordinates, Coordinate2D {
private final double x;
private final double y;
private final String str;
/**
* 实例化一个坐标
*
* @param x 坐标的横轴
* @param y 坐标的纵轴
*/
public DoubleCoordinateTwo(double x, double y) {
this.x = x;
this.y = y;
str = "(" + this.x + ',' + this.y + ')';
}
/**
* 将两个操作数进行求和的方法，具体用法请参阅API说明。
*
* The method for summing two operands, please refer to the API description for specific usage.
*
* @param value 被求和的参数 Parameters to be summed
* @return 求和之后的数值 the value after the sum
*
* 两个坐标之间的每一个轴的数据之和
*
* diff of data for each axis between two coordinates
*/
@Override
public DoubleCoordinateTwo add(DoubleCoordinateTwo value) {
return new DoubleCoordinateTwo(this.x + value.x, this.y + value.y);
}
/**
* 在两个操作数之间做差的方法，具体用法请参阅API说明。
*
* The method of making a difference between two operands, please refer to the API description for specific usage.
*
* @param value 被做差的参数（被减数） The parameter to be subtracted (minuend)
* @return 差异数值 difference value
*
* 两个坐标中的 x y 轴做减法，取得两个坐标之差。
*
* Subtract the x and y axes of the two coordinates to obtain the difference between the two coordinates.
*/
@Override
public DoubleCoordinateTwo diff(DoubleCoordinateTwo value) {
return new DoubleCoordinateTwo(this.x - value.x, this.y - value.y);
}
/**
* 将两个操作数进行求和的方法，具体用法请参阅API说明。
*
* The method for summing two operands, please refer to the API description for specific usage.
*
* @param value 被求和的参数 Parameters to be summed
* @return 求和之后的数值 the value after the sum
*
* There is no description for the super interface, please refer to the subclass documentation
*/
@Override
public DoubleCoordinateTwo add(Number value) {
double v = value.doubleValue();
return new DoubleCoordinateTwo(this.x + v, this.y + v);
}
/**
* 在两个操作数之间做差的方法，具体用法请参阅API说明。
*
* The method of making a difference between two operands, please refer to the API description for specific usage.
*
* @param value 被做差的参数（被减数） The parameter to be subtracted (minuend)
* @return 差异数值 difference value
* There is no description for the super interface, please refer to the subclass documentation
*/
@Override
public DoubleCoordinateTwo diff(Number value) {
double v = value.doubleValue();
return new DoubleCoordinateTwo(this.x - v, this.y - v);
}
/**
* 将当前对象转换成为其子类实现，其具有强大的类型拓展效果，能够实现父类到子类的转换操作。
*
* Transforming the current object into its subclass implementation has a powerful type extension effect, enabling the conversion operation from parent class to subclass.
*
* @return 当前类对应的子类实现数据类型的对象。
*
* The subclass corresponding to the current class implements objects of data type.
*/
@Override
public DoubleCoordinateTwo expand() {
return this;
}
@Override
public String toString() {
return this.str;
}
/**
* @return 该浮点坐标的维度数量，每一个坐标都有不同的维度，获取到所有维度的数量，有助于定位到坐标点的位置。
*
* The number of dimensions of the floating-point coordinate, each coordinate has a different dimension, and obtaining the number of all dimensions is helpful for locating the position of the coordinate point.
*/
@Override
public int getNumberOfDimensions() {
return 0b10;
}
/**
* @return 该浮点坐标的数组形式，将浮点坐标转换成为一个数组返回出去，当然某些实现类可能会直接将数组作为一个对象的全局直接返回，这样有利于性能。
*
* In the array form of the floating point coordinates, the floating point coordinates are converted into an array and returned. Of course, some implementation classes may directly return the array as a global object, which is beneficial to performance.
*/
@Override
public double[] toArray() {
return new double[]{x, y};
}
/**
* @return 该类的实现类对象，用于拓展该接口的子类
*/
@Override
public DoubleCoordinateTwo extend() {
return this;
}
/**
* @return X轴的数值
*
* The value of the X axis
*/
@Override
public Double getX() {
return this.x;
}
/**
* @return Y轴的数值
*
* The value of the Y axis
*/
@Override
public Double getY() {
return this.y;
}
}