shipUtils.Math Namespace Reference

Functions
def	isAprox (a, b, tol=0.000001)
def	isSamePoint (a, b, tol=0.000001)
def	isSameVertex (a, b, tol=0.0001)

Function Documentation

isAprox()

def shipUtils.Math.isAprox	(		a,
			b,
			tol = 0.000001
	)

returns if a value is into (b-tol,b+tol)
@param a Value to compare.
@param b Center of valid interval
@param tol Radius of valid interval
@return True if a is into (b-tol,b+tol), False otherwise

Referenced by shipUtils.Math.isSamePoint(), and shipUtils.Math.isSameVertex().

isSamePoint()

def shipUtils.Math.isSamePoint	(		a,
			b,
			tol = 0.000001
	)

returns if two points are the same with a provided tolerance
@param a Point to compare.
@param b Reference point.
@param tol Radius of valid interval
@return True if twice point are the same, False otherwise
@note FreeCAD::Base::Vector types must be provided

References shipUtils.Math.isAprox().

isSameVertex()

def shipUtils.Math.isSameVertex	(		a,
			b,
			tol = 0.0001
	)

returns if two points are the same with a provided tolerance
@param a Point to compare.
@param b Reference point.
@param tol Radius of valid interval
@return True if twice point are the same, False otherwise
@note FreeCAD::Part::Vertex types must be provided

References shipUtils.Math.isAprox().