→ home

→ index of namespace default

→ index of project tkmath

→ index of module tkmath

Class `tkmath.Complexf`

Synopsis: This class represents a single precision complex number.

Base classes:

core.Object

Methods:

add(Complexf v) - add complex number v to this instance
div(Complexf v) - Divide this instance by complex v
getA() : float - Get a property of re^ia
getAbs() : float - Returns length of complex number
getAbsSqr() : float - Returns squared length of complex number (faster than abs)
getPolarString() : String - Get string representation of complex number (re^ia)
getR() : float - Get r property of re^ia
getString() : String - Get string representation of complex number (x+iy)
getX() : float - Get x property of x+iy
getY() : float - Get y property of x+iy
init(float a, b) - Set value of instance to x=a and y=b (x+iy)
initPolar(float a, b) - Set value of instance to r=_a and a=_b (re^ia)
invert() - Invert this instance (v=1/v)
mul(Complexf v) - Multiply this instance with complex v
mulConj(Complexf v) : float - Multiply this instance with complex conjugated v, ((x₁+iy₁)*(x₂-iy₂))
mulf(float v) - Multiply this instance with scalar v
New(float a, b) : Complexf - Returns new instance with values x=a and y=b of (x+iy)
NewPolar(float va, vb) : Complexf - Returns new instance with values r=va and a=vb of (re^ia)
setA(float a) - Set a property of re^ia
setR(float r) - Set r property of re^ia
setX(float x) - Set x property of x+iy
setY(float x) - Set y property of x+iy
sub(Complexf v) - substract complex number v from this instance
unit() - Set length of instance to 1
unitScale(float s) - Set length of instance to s

Method add

add complex number v to this instance

Signature

add

(

Complexf

)

Arguments

Complexf

–

complex value to add

→ top of page

Method div

Divide this instance by complex v

Signature

div

(

Complexf

)

Arguments

Complexf

–

complex value to divide through

→ top of page

Method getA

Get a property of re^ia

Signature

getA

(

)

float

Returns

float

–

→ top of page

Method getAbs

Returns length of complex number

Signature

getAbs

(

)

float

Returns

float

–

length

→ top of page

Method getAbsSqr

Returns squared length of complex number (faster than abs)

Signature

getAbsSqr

(

)

float

Returns

float

–

length²

→ top of page

Method getPolarString

Get string representation of complex number (re^ia)

Signature

getPolarString

(

)

String

Returns

String

–

→ top of page

Method getR

Get r property of re^ia

Signature

getR

(

)

float

Returns

float

–

r property

→ top of page

Method getString

Get string representation of complex number (x+iy)

Signature

getString

(

)

String

Returns

String

–

string representation (x+iy)

→ top of page

Method getX

Get x property of x+iy

Signature

getX

(

)

float

Returns

float

–

x property

→ top of page

Method getY

Get y property of x+iy

Signature

getY

(

)

float

Returns

float

–

y property

→ top of page

Method init

Set value of instance to x=a and y=b (x+iy)

Signature

init	(	float	a	,
		float	b
		)

Arguments

float	a	–	new x value
float	b	–	new y value

→ top of page

Method initPolar

Set value of instance to r=_a and a=_b (re^ia)

Signature

initPolar	(	float	a	,
		float	b
		)

Arguments

float	a	–	new r value
float	b	–	new a value

→ top of page

Method invert

Invert this instance (v=1/v)

Signature

invert

(

)

→ top of page

Method mul

Multiply this instance with complex v

Signature

mul

(

Complexf

)

Arguments

Complexf

–

complex value to multiply

→ top of page

Method mulConj

Multiply this instance with complex conjugated v, ((x₁+iy₁)*(x₂-iy₂))

Signature

mulConj	(	Complexf	v	)
	:	float

Arguments

Complexf

–

complex value to conjugate and multiply

Returns

float

–

result of complex conjugated multiplication (scalar value)

→ top of page

Method mulf

Multiply this instance with scalar v

Signature

mulf

(

float

)

Arguments

float

–

scalar value to multiply

→ top of page

Method New

Returns new instance with values x=a and y=b of (x+iy)

Signature

New	(	float	a	,
		float	b
		)
	:	Complexf

Arguments

float	a	–	new x value
float	b	–	new y value

Returns

Complexf

–

new instance of Complexf (x+iy)

→ top of page

Method NewPolar

Returns new instance with values r=va and a=vb of (re^ia)

Signature

NewPolar	(	float	va	,
		float	vb
		)
	:	Complexf

Arguments

float	va	–	new r value
float	vb	–	new a value

Returns

Complexf

–

new instance of Complexf (re^ia)

→ top of page

Method setA

Set a property of re^ia

Signature

setA

(

float

)

Arguments

float

–

new a value

→ top of page

Method setR

Set r property of re^ia

Signature

setR

(

float

)

Arguments

float

–

new r value

→ top of page

Method setX

Set x property of x+iy

Signature

setX

(

float

)

Arguments

float

–

new x value

→ top of page

Method setY

Set y property of x+iy

Signature

setY

(

float

)

Arguments

float

–

→ top of page

Method sub

substract complex number v from this instance

Signature

sub

(

Complexf

)

Arguments

Complexf

–

complex value to substract

→ top of page

Method unit

Set length of instance to 1

Signature

unit

(

)

→ top of page

Method unitScale

Set length of instance to s

Signature

unitScale

(

float

)

Arguments

float

–

new length for complex number

→ top of page

Project Modules:	`tkmath`
Project Classes:	`Complexd` , `Complexf` , `Math` , `Matrix` , `Matrix2d` , `Matrix2f` , `Matrix3d` , `Matrix3f` , `Matrix4d` , `Matrix4f` , `Quaterniond` , `Quaternionf` , `Vector2d` , `Vector2f` , `Vector3d` , `Vector3f` , `Vector4d` , `Vector4f`
Project Functions:	`absd` , `absf` , `acoscd` , `acoscf` , `acosd` , `acosf` , `acoshcd` , `acoshcf` , `acoshd` , `acoshf` , `asincd` , `asincf` , `asind` , `asinf` , `asinhcd` , `asinhcf` , `asinhd` , `asinhf` , `atan2d` , `atan2f` , `atancd` , `atancf` , `atand` , `atanf` , `atanhcd` , `atanhcf` , `atanhd` , `atanhf` , `ceild` , `ceilf` , `complexd` , `complexf` , `complexfPolar` , `complexfPolar` , `coscd` , `coscf` , `cosd` , `cosf` , `coshcd` , `coshcf` , `coshd` , `coshf` , `exp10d` , `exp10f` , `exp2d` , `exp2f` , `expcd` , `expcf` , `expd` , `expf` , `floord` , `floorf` , `hypotd` , `hypotf` , `log10d` , `log10f` , `log2d` , `log2f` , `logcd` , `logcf` , `logd` , `logf` , `matrix2d` , `matrix2f` , `matrix3d` , `matrix3f` , `matrix4d` , `matrix4f` , `modd` , `modf` , `powcd` , `powcf` , `powd` , `powf` , `quaterniond` , `quaternionf` , `relCmpd` , `relCmpf` , `relErrCmpd` , `relErrCmpf` , `roundd` , `roundf` , `sincd` , `sincf` , `sind` , `sinf` , `sinhcd` , `sinhcf` , `sinhd` , `sinhf` , `sqrtcd` , `sqrtcf` , `sqrtd` , `sqrtf` , `tancf` , `tancf` , `tand` , `tanf` , `tanhcd` , `tanhcf` , `tanhd` , `tanhf` , `vector2d` , `vector2f` , `vector3d` , `vector3f` , `vector4d` , `vector4f`
All Namespaces:	`default` , `ui`
All Projects:	`core` , `debugtext` , `tkfreetype2` , `tkmath` , `tkmidi` , `tkopengl` , `tkportaudio` , `tksdl` , `tkui` , `tkunit`

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54

Class tkmath.Complexf

Class `tkmath.Complexf`