vectors2d 0.95

Small but useful module that allows the work with vectors in 2-dimensional space.

Vectors2D

It's a small module called to facilitate work with vectors in Python. Adds class Vector2D and operations with vectors in 2 dimensions. All functions take Vector2D. They also take tuples or lists of int or float with len == 2. Vectors can be added, subbed, multiplied by other vector or by int/float and more. You can find all the functions of the module below.

---

Installing

Simply run pip install vectors2d from your command line.

Class:

Vector2D : takes ints, floats, tuple, list when creating. If not given, creates zero vector (0;0). If given only one number, assigns it to "x" coordinate. Also can take other Vector2D object.

Class methods:

1. iszero() : check if vector is zero vector.
2. isparallel(vector) : check if the vector is parallel to the given vector. Takes Vector2D, list ot tuple.
3. isperpendicular(vector) : check if the vector is perpendicular to the given vector. Takes Vector2D, list ot tuple.
4. iscodirected(vector) : check if vector is co-directed to given vector. Takes Vector2D, list ot tuple.

Global functions:

1. absolute_vector(vector) : calculates absolute value of given vector. Takes Vector2D object, list or tuple. Returns float;
2. sum_vectors(*vectors) : adds all the given vectors. Takes Vector2D objects, lists and tuples in any combination. Returns Vector2D;
3. sub_vectors(*vectors) : subtracts all the given vectors. Takes Vector2D objects, lists and tuples in any combination. Returns Vector2D;
4. mult_vector(vector, multiplier) : multiplies given vector by given number (can be int or float). "vector" takes Vector2D object, list and tuple as vector; "multiplier" takes int and float as multiplier. Returns Vector2D;
5. scalar_mult_vectors(vectors*) : calculates scalar multiplication of given vectors. Takes Vector2D objects, lists and tuples in any combination. Returns float;
6. get_angle(vector1, vector2) : returns angle between two given vectors in radians. Takes Vector2D objects, lists and tuples in any combination. Returns float;
7. vector_from_dots(dot1, dot2) : calculates vector from two given dots. Returns Vector2D.

GitHub:

Extended documentation with examples is available at

https://github.com/MitryP/vectors/