モジュール mbcp.mp_math.vector

本模块定义了3维向量的类Vector3，以及一些常用的向量。

class Vector3

method __init__(self, x: float, y: float, z: float)

説明: 3维向量

引数:

• x (float): x轴分量
• y (float): y轴分量
• z (float): z轴分量

ソースコード または GitHubで表示

def __init__(self, x: float, y: float, z: float):
    self.x = x
    self.y = y
    self.z = z

method approx(self, other: Vector3, epsilon: float = APPROX) -> bool

説明: 判断两个向量是否近似相等。

引数:

• other (Vector3): 另一个向量
• epsilon (float): 误差

戻り値: bool: 是否近似相等

ソースコード または GitHubで表示

def approx(self, other: 'Vector3', epsilon: float=APPROX) -> bool:
    return all([abs(self.x - other.x) < epsilon, abs(self.y - other.y) < epsilon, abs(self.z - other.z) < epsilon])

method cal_angle(self, other: Vector3) -> AnyAngle

説明: 计算两个向量之间的夹角。

TIP

向量夹角计算公式:

$$\theta =\arccos (\frac{v1\cdot v2}{|v1|\cdot |v2|})$$

引数:

• other (Vector3): 另一个向量

戻り値: AnyAngle: 夹角

ソースコード または GitHubで表示

def cal_angle(self, other: 'Vector3') -> 'AnyAngle':
    return AnyAngle(math.acos(self @ other / (self.length * other.length)), is_radian=True)

method cross(self, other: Vector3) -> Vector3

説明: 向量积 叉乘：v1 x v2 -> v3

TIP

叉乘运算法则为:

$$v1\times v2=(v{1}_y\cdot v{2}_z-v{1}_z\cdot v{2}_y,v{1}_z\cdot v{2}_x-v{1}_x\cdot v{2}_z,v{1}_x\cdot v{2}_y-v{1}_y\cdot v{2}_x)$$

转换为行列式形式:

$$v1\times v2=\left|\begin{array}{ccc}i& j& k\\ v{1}_x& v{1}_y& v{1}_z\\ v{2}_x& v{2}_y& v{2}_z\end{array}\right|$$

引数:

• other (Vector3): 另一个向量

戻り値: Vector3: 叉乘结果

ソースコード または GitHubで表示

def cross(self, other: 'Vector3') -> 'Vector3':
    return Vector3(self.y * other.z - self.z * other.y, self.z * other.x - self.x * other.z, self.x * other.y - self.y * other.x)

method is_approx_parallel(self, other: Vector3, epsilon: float = APPROX) -> bool

説明: 判断两个向量是否近似平行。

引数:

• other (Vector3): 另一个向量
• epsilon (float): 误差

戻り値: bool: 是否近似平行

ソースコード または GitHubで表示

def is_approx_parallel(self, other: 'Vector3', epsilon: float=APPROX) -> bool:
    return self.cross(other).length < epsilon

method is_parallel(self, other: Vector3) -> bool

説明: 判断两个向量是否平行。

引数:

• other (Vector3): 另一个向量

戻り値: bool: 是否平行

ソースコード または GitHubで表示

def is_parallel(self, other: 'Vector3') -> bool:
    return self.cross(other).approx(zero_vector3)

method normalize(self)

説明: 将向量归一化。

自体归一化，不返回值。

ソースコード または GitHubで表示

def normalize(self):
    length = self.length
    self.x /= length
    self.y /= length
    self.z /= length

@property

method np_array(self) -> np.ndarray

戻り値: np.ndarray: numpy数组

ソースコード または GitHubで表示

@property
def np_array(self) -> 'np.ndarray':
    return np.array([self.x, self.y, self.z])

@property

method length(self) -> float

説明: 向量的模。

戻り値: float: 模

ソースコード または GitHubで表示

@property
def length(self) -> float:
    return math.sqrt(self.x ** 2 + self.y ** 2 + self.z ** 2)

@property

method unit(self) -> Vector3

説明: 获取该向量的单位向量。

戻り値: Vector3: 单位向量

ソースコード または GitHubで表示

@property
def unit(self) -> 'Vector3':
    return self / self.length

method __abs__(self)

ソースコード または GitHubで表示

def __abs__(self):
    return self.length

@overload

method self + other: Vector3 => Vector3

ソースコード または GitHubで表示

@overload
def __add__(self, other: 'Vector3') -> 'Vector3':
    ...

@overload

method self + other: Point3 => Point3

ソースコード または GitHubで表示

@overload
def __add__(self, other: 'Point3') -> 'Point3':
    ...

method self + other

説明: V + P -> P

V + V -> V

引数:

• other (Vector3 | Point3): 另一个向量或点

戻り値: Vector3 | Point3: 新的向量或点

ソースコード または GitHubで表示

def __add__(self, other):
    if isinstance(other, Vector3):
        return Vector3(self.x + other.x, self.y + other.y, self.z + other.z)
    elif isinstance(other, Point3):
        return Point3(self.x + other.x, self.y + other.y, self.z + other.z)
    else:
        raise TypeError(f"unsupported operand type(s) for +: 'Vector3' and '{type(other)}'")

method __eq__(self, other)

説明: 判断两个向量是否相等。

引数:

• other (Vector3): 另一个向量

戻り値: bool: 是否相等

ソースコード または GitHubで表示

def __eq__(self, other):
    return approx(self.x, other.x) and approx(self.y, other.y) and approx(self.z, other.z)

method self + other: Point3 => Point3

説明: P + V -> P

别去点那边实现了。

引数:

• other (Point3): 另一个点

戻り値: Point3: 新的点

ソースコード または GitHubで表示

def __radd__(self, other: 'Point3') -> 'Point3':
    return Point3(self.x + other.x, self.y + other.y, self.z + other.z)

@overload

method self - other: Vector3 => Vector3

ソースコード または GitHubで表示

@overload
def __sub__(self, other: 'Vector3') -> 'Vector3':
    ...

@overload

method self - other: Point3 => Point3

ソースコード または GitHubで表示

@overload
def __sub__(self, other: 'Point3') -> 'Point3':
    ...

method self - other

説明: V - P -> P

V - V -> V

引数:

• other (Vector3 | Point3): 另一个向量或点

戻り値: Vector3 | Point3: 新的向量

ソースコード または GitHubで表示

def __sub__(self, other):
    if isinstance(other, Vector3):
        return Vector3(self.x - other.x, self.y - other.y, self.z - other.z)
    elif isinstance(other, Point3):
        return Point3(self.x - other.x, self.y - other.y, self.z - other.z)
    else:
        raise TypeError(f'unsupported operand type(s) for -: "Vector3" and "{type(other)}"')

method self - other: Point3

説明: P - V -> P

引数:

• other (Point3): 另一个点

戻り値: Point3: 新的点

ソースコード または GitHubで表示

def __rsub__(self, other: 'Point3'):
    if isinstance(other, Point3):
        return Point3(other.x - self.x, other.y - self.y, other.z - self.z)
    else:
        raise TypeError(f"unsupported operand type(s) for -: '{type(other)}' and 'Vector3'")

@overload

method self * other: Vector3 => Vector3

ソースコード または GitHubで表示

@overload
def __mul__(self, other: 'Vector3') -> 'Vector3':
    ...

@overload

method self * other: RealNumber => Vector3

ソースコード または GitHubで表示

@overload
def __mul__(self, other: RealNumber) -> 'Vector3':
    ...

method self * other: int | float | Vector3 => Vector3

説明: 数组运算 非点乘。点乘使用@，叉乘使用cross。

引数:

• other (Vector3 | float): 另一个向量或数

戻り値: Vector3: 数组运算结果

ソースコード または GitHubで表示

def __mul__(self, other: 'int | float | Vector3') -> 'Vector3':
    if isinstance(other, Vector3):
        return Vector3(self.x * other.x, self.y * other.y, self.z * other.z)
    elif isinstance(other, (float, int)):
        return Vector3(self.x * other, self.y * other, self.z * other)
    else:
        raise TypeError(f"unsupported operand type(s) for *: 'Vector3' and '{type(other)}'")

method self * other: RealNumber => Vector3

ソースコード または GitHubで表示

def __rmul__(self, other: 'RealNumber') -> 'Vector3':
    return self.__mul__(other)

method self @ other: Vector3 => RealNumber

説明: 点乘。

引数:

• other (Vector3): 另一个向量

戻り値: float: 点乘结果

ソースコード または GitHubで表示

def __matmul__(self, other: 'Vector3') -> 'RealNumber':
    return self.x * other.x + self.y * other.y + self.z * other.z

method self / other: RealNumber => Vector3

ソースコード または GitHubで表示

def __truediv__(self, other: RealNumber) -> 'Vector3':
    return Vector3(self.x / other, self.y / other, self.z / other)

method - self => Vector3

説明: 取负。

戻り値: Vector3: 负向量

ソースコード または GitHubで表示

def __neg__(self) -> 'Vector3':
    return Vector3(-self.x, -self.y, -self.z)

var zero_vector3

• 説明: 零向量

• タイプ: Vector3

• デフォルト: Vector3(0, 0, 0)

var x_axis

• 説明: x轴单位向量

• タイプ: Vector3

• デフォルト: Vector3(1, 0, 0)

var y_axis

• 説明: y轴单位向量

• タイプ: Vector3

• デフォルト: Vector3(0, 1, 0)

var z_axis

• 説明: z轴单位向量

• タイプ: Vector3

• デフォルト: Vector3(0, 0, 1)