package coffee.liz.ecs.math;

import java.util.function.Function;

/**
 * Cartesian vectors.
 *
 * @param <T>
 *            the numeric type of vector components
 */
public interface Vec2<T> {
	/**
	 * @return the x coordinate
	 */
	T getX();

	/**
	 * @return the y coordinate
	 */
	T getY();

	/**
	 * Adds another vector to this vector.
	 *
	 * @param other
	 *            the vector to add
	 * @return a new vector with the result
	 */
	Vec2<T> plus(final Vec2<T> other);

	/**
	 * Subtracts another vector from this vector.
	 *
	 * @param other
	 *            the vector to subtract
	 * @return a new vector with the result
	 */
	Vec2<T> minus(final Vec2<T> other);

	/**
	 * Scales this vector by the given factors.
	 *
	 * @param scaleX
	 *            the x scale factor
	 * @param scaleY
	 *            the y scale factor
	 * @return a new scaled vector
	 */
	Vec2<T> scale(final T scaleX, final T scaleY);

	/**
	 * Scales this vector by the given vector.
	 *
	 * @param scale
	 *            scale vec.
	 * @return a new scaled vector
	 */
	default Vec2<T> scale(final Vec2<T> scale) {
		return scale(scale.getX(), scale.getY());
	}

	/**
	 * Length of the vector.
	 *
	 * @return length.
	 */
	float length();

	/**
	 * @return Vec2<Integer> components of {@link Vec2<T>}
	 */
	Vec2<Integer> intValue();

	/**
	 * @return Vec2<Float> components of {@link Vec2<T>}
	 */
	Vec2<Float> floatValue();

	/**
	 * @param xTransform
	 *            transform of x component.
	 * @param yTransform
	 *            transform of y component.
	 * @return transformed vec applying {@param xTransform} to x component,
	 *         {@param yTransform} to y component.
	 */
	Vec2<T> transform(final Function<T, T> xTransform, final Function<T, T> yTransform);
}