Package that helps you work with vector algebra !
Project description
vectogebra v 0.0.7 - 15 May 2022
Python module for vector algebra
easy to use vector algebra library for python, that lets ypu work with vectors in an efficient way. apart from core vector object, many other vector operations are supported. these can be imported from vectogebra.utilities.
this library was made by keeping its applications in Physics in mind (Mechanics, Optics, etc.)
- does not depend on any external libraries except math library.
- fully functional
- easy to use
- supports nearly all vector operations
- beginner friendly
- physics friendly
- Open for modifications
💥 Install
pip install --upgrade vectogebra
⭐ Start by importing the vector class
import vectogebra.vector as vect
OR
from vectogebra import vector as vect
⭐ Also import useful utility functions
import vectogebra.utitlies as vut
OR
from vectogebra import utilities as vut
🔥 Description of the module
this module currently have two components : one is vectogebra.vector
, which is the vector class (boject) defination. it contains the basic functionality.
the second component, vectogebra.utilities
contains useful functions that are defined for the above mentioned vector class like, function to find angle between
two vectors, etc.
Create a vector object :
import vectogebra.vector as vect
v1 = vect(1,2,3)
🔢 Algebric operations :
1. Addition
consider two(or more) vectors : a,b,...
their sum will be given by :
s = a + b + ...
sum s
will also be a vector object.
2. Subtraction
Vectors can be subtracted using the minus (-
) operator.
example :
s = a - b + c - d + ...
resultant s
will also be a vector object.
3. Dot product / scalar product and scalar multiplication
the *
operator will be used for dot product, or multiplication by a scalar.
example :
p = a * b * c * d * ...
is same as "a dot b dot c dot ...".
p = 5*v
OR v*5
is same as "scalar 5 multiplied to vector v".
4. Cross product / vector multiplication
the ^
operator will be used for cross product, or vector product.
example :
p = a^b
is same as "p equals a cross b".
5. division by a scalar
simply divide a vector by a scalar. NOTE : division by zero or division vector is not supported.
example :
p = v / 5
is same as "p equals v divided by 5".
❌✔️ Logical operations :
1. Equality
a == b
returnes True when a and b are equal in magnitude and direction. else, it returns False
2. Inequality
a != b
have its usual meaning
3. grater / lesser
the magnitude of the vectors can be compared using common logical operators.
# a and b are vectors
a > b
a < b
a >= b
a <= b
Attributes of the vector object
Components
for a vector v1,
v1.x
ORv1.i
v1.y
ORv1.j
v1.z
ORv1.k
Magnitude
v1.magnitude
ORvi.mod
Magnitude squared (useful when precesion is required)
v1.magnitude_squared
ORv1.mod_squared
Type
v1.type
different fromtype(v1)
🚀 Vectogebra's Utitlies (vut)
important utility functions for the vector object. import :
import vectogebra.utilities as vut
S. no. | function | Return value |
---|---|---|
1. | vut.angle(v1,v2) |
angle between v1 and v |
2. | vut.dot(v1,v2) |
dot product (or scalar product) of vectors v1 and v2 |
3. | vut.cross(v1,v2) |
cross product (or vector product) of v1 and v2 |
4. | vut.magnitude(v1) |
magnitude of v1 and v2 |
5. | vut.is_perpendicular(v1,v2) |
True when v1 is perpendicular to v2 else it returns False |
6. | vut.is_parallel(v1,v2) |
True whe v1 is parallel to ve else False |
7. | vut.scalar_component_parallel(v1,v2) |
Magnitude of component of v1 parallel to v2 |
8. | vut.scalar_component_perpendicular(v1,v2) |
Magnitude of component of v1 perpendicular to v2 |
9. | vut.vector_component_parallel(v1,v2) |
Vector component of v1 parallel to v2 |
10. | vut.vector_component_perpendicular(v1,v2) |
Vector compoment of v1 perpendicular to v2 |
11. | vut.unit_vector(v) OR vut.direction(v) |
Returns the unit vector parallel to v |
12. | vut.dot(v1,v2) |
dot product |
13. | vut.cross(v1,v2) |
cross product |
14. | vut.parallelogram_area(v1,v2) |
parallelogram's area formed by joining v1 and v2 tail to tail |
15. | vut.box(a,b,c) |
Box product or scalar triple product |
16. | vut.collinear(a,b,c) |
returns True if a,b,c are collinear |
⭐ | Conversions | |
17. | vut.vector_to_list(v) |
a list of the components of v |
18. | vut.vector_to_dict(v) |
a dictionary of the components of v |
19. | vut.vector_to_tuple(v) |
a tuple of the components of v |
20. | vut.list_to_vector(l) |
a vector object from a list of components |
21. | vut.dict_to_vector(d) |
a vector object from a dictionary of components |
22. | vut.tuple_to_vector(t) |
a vector object from a tuple of components |
(more to come)
Author: Mohammad Maasir
License: MIT
date-created: 8th of May, 2022
PyPi :https://pypi.org/project/vectogebra/
Copyright (c) 2022 Mohammad Maasir
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for vectogebra-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 098070151c81f59bb4a9b497ec4e0a2e905407c6ab9e4c27dea57a64f23d3d6d |
|
MD5 | 0f3048d13e0b5179ec0d2b5193633206 |
|
BLAKE2b-256 | bc0796dfe4393b93af2a2ee61e15f5d7ae85f016c05b09c89d73876fc57e545a |