@bitbybit-dev/base
Version:
Bit By Bit Developers Base CAD Library to Program Geometry
350 lines (349 loc) • 9.18 kB
TypeScript
import * as Inputs from "../inputs";
/**
* Contains various math methods.
*/
export declare class MathBitByBit {
/**
* Creates a number
* @param inputs a number to be created
* @returns number
* @group create
* @shortname number
* @drawable false
*/
number(inputs: Inputs.Math.NumberDto): number;
/**
* Does basic math operations
* @param inputs two numbers and operator
* @returns Result of math operation action
* @group operations
* @shortname two numbers
* @drawable false
*/
twoNrOperation(inputs: Inputs.Math.ActionOnTwoNumbersDto): number;
/**
* Does modulus operation
* @param inputs two numbers and operator
* @returns Result of modulus operation
* @group operations
* @shortname modulus
* @drawable false
*/
modulus(inputs: Inputs.Math.ModulusDto): number;
/**
* Does rounding to decimals
* @param inputs a number and decimal places
* @returns Result of rounding
* @group operations
* @shortname round to decimals
* @drawable false
*/
roundToDecimals(inputs: Inputs.Math.RoundToDecimalsDto): number;
/**
* Does basic math operations on one number
* @param inputs one number and operator action
* @returns Result of math operation
* @group operations
* @shortname one number
* @drawable false
*/
oneNrOperation(inputs: Inputs.Math.ActionOnOneNumberDto): number;
/**
* Remaps a number from one range to another
* @param inputs one number and operator action
* @returns Result of mapping
* @group operations
* @shortname remap
* @drawable false
*/
remap(inputs: Inputs.Math.RemapNumberDto): number;
/**
* Creates a random number between 0 and 1
* @returns A random number between 0 and 1
* @group generate
* @shortname random 0 - 1
* @drawable false
*/
random(): number;
/**
* Creates a random number between low and high value
* @param inputs low and high numbers
* @returns A random number
* @group generate
* @shortname random number
* @drawable false
*/
randomNumber(inputs: Inputs.Math.RandomNumberDto): number;
/**
* Creates random numbers between low and high values
* @param inputs low and high numbers
* @returns A list of random numbers
* @group generate
* @shortname random numbers
* @drawable false
*/
randomNumbers(inputs: Inputs.Math.RandomNumbersDto): number[];
/**
* Creates a PI number
* @returns A number PI
* @group generate
* @shortname π
* @drawable false
*/
pi(): number;
/**
* Rounds the number to decimal places
* @param inputs a number to be rounded to decimal places
* @returns number
* @group operations
* @shortname to fixed
* @drawable false
*/
toFixed(inputs: Inputs.Math.ToFixedDto): string;
/**
* Adds two numbers
* @param inputs two numbers
* @returns number
* @group basics
* @shortname add
* @drawable false
*/
add(inputs: Inputs.Math.TwoNumbersDto): number;
/**
* Subtracts two numbers
* @param inputs two numbers
* @returns number
* @group basics
* @shortname subtract
* @drawable false
*/
subtract(inputs: Inputs.Math.TwoNumbersDto): number;
/**
* Multiplies two numbers
* @param inputs two numbers
* @returns number
* @group basics
* @shortname multiply
* @drawable false
*/
multiply(inputs: Inputs.Math.TwoNumbersDto): number;
/**
* Divides two numbers
* @param inputs two numbers
* @returns number
* @group basics
* @shortname divide
* @drawable false
*/
divide(inputs: Inputs.Math.TwoNumbersDto): number;
/**
* Powers a number
* @param inputs two numbers
* @returns number
* @group basics
* @shortname power
* @drawable false
*/
power(inputs: Inputs.Math.TwoNumbersDto): number;
/**
* Gets the square root of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname sqrt
* @drawable false
*/
sqrt(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the absolute value of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname abs
* @drawable false
*/
abs(inputs: Inputs.Math.NumberDto): number;
/**
* Rounds a number
* @param inputs a number
* @returns number
* @group basics
* @shortname round
* @drawable false
*/
round(inputs: Inputs.Math.NumberDto): number;
/**
* Floors a number
* @param inputs a number
* @returns number
* @group basics
* @shortname floor
* @drawable false
*/
floor(inputs: Inputs.Math.NumberDto): number;
/**
* Ceils a number
* @param inputs a number
* @returns number
* @group basics
* @shortname ceil
* @drawable false
*/
ceil(inputs: Inputs.Math.NumberDto): number;
/**
* Negates a number
* @param inputs a number
* @returns number
* @group basics
* @shortname negate
* @drawable false
*/
negate(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the natural logarithm of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname ln
* @drawable false
*/
ln(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the base 10 logarithm of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname log10
* @drawable false
*/
log10(inputs: Inputs.Math.NumberDto): number;
/**
* Raises 10 to the power of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname ten pow
* @drawable false
*/
tenPow(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the sine of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname sin
* @drawable false
*/
sin(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the cosine of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname cos
* @drawable false
*/
cos(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the tangent of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname tan
* @drawable false
*/
tan(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the arcsine of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname asin
* @drawable false
*/
asin(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the arccosine of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname acos
* @drawable false
*/
acos(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the arctangent of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname atan
* @drawable false
*/
atan(inputs: Inputs.Math.NumberDto): number;
/**
* Gets the natural exponent of a number
* @param inputs a number
* @returns number
* @group basics
* @shortname exp
* @drawable false
*/
exp(inputs: Inputs.Math.NumberDto): number;
/**
* Converts degrees to radians
* @param inputs a number in degrees
* @returns number
* @group basics
* @shortname deg to rad
* @drawable false
*/
degToRad(inputs: Inputs.Math.NumberDto): number;
/**
* Converts radians to degrees
* @param inputs a number in radians
* @returns number
* @group basics
* @shortname rad to deg
* @drawable false
*/
radToDeg(inputs: Inputs.Math.NumberDto): number;
/**
* Eases a number by providing x parameter 0-1 and a range of output values
* @param inputs a number, min and max values, and ease type
* @returns number
* @group operations
* @shortname ease
* @drawable false
*/
ease(inputs: Inputs.Math.EaseDto): number;
private easeInSine;
private easeOutSine;
private easeInOutSine;
private easeInQuad;
private easeOutQuad;
private easeInOutQuad;
private easeInCubic;
private easeOutCubic;
private easeInOutCubic;
private easeInQuart;
private easeOutQuart;
private easeInOutQuart;
private easeInQuint;
private easeOutQuint;
private easeInOutQuint;
private easeInExpo;
private easeOutExpo;
private easeInOutExpo;
private easeInCirc;
private easeOutCirc;
private easeInOutCirc;
private easeInBack;
private easeOutBack;
private easeInOutBack;
private easeInElastic;
private easeOutElastic;
private easeInOutElastic;
private easeInBounce;
private easeOutBounce;
private easeInOutBounce;
}