JSDoc: Module: Column

Methods

(inner) empty(lenopt, dtype) → {ColNum|ColStr}

Parameters:

Name	Type	Attributes	Default	Description
`len`	number	<optional>	0
`dtype`	DType \| 's'		null

Source:

Column.js, line 1729

Returns:

empty column

Type: ColNum | ColStr

(inner) from(xs, toDtypeopt, nullable, doCloneopt) → {ColNum|ColStr}

Parameters:

Name	Type	Attributes	Default
`xs`	Array.<number> \| Array.<string> \| TypedArray \| ColNum \| ColStr
`toDtype`	DType	<optional> <nullable>	null
`doClone`	boolean	<optional>	true

Source:

Column.js, line 1627

Returns:

column

Type: ColNum | ColStr

(inner) fromFunct(f, n, dtypeopt) → {ColNum|ColStr}

Parameters:

Name	Type	Attributes	Default
`f`	function
`n`	number		0
`dtype`	DType \| 's'	<optional>	null

Source:

Column.js, line 1840

Returns:

Type: ColNum | ColStr

(inner) isCol(xs) → {boolean}

Parameters:

Name	Type	Description
`xs`	*

Source:

Column.js, line 1832

Returns:

Type: boolean

(inner) isColNum(xs) → {boolean}

Parameters:

Name	Type	Description
`xs`	*

Source:

Column.js, line 1820

Returns:

Type: boolean

(inner) isColStr(xs) → {boolean}

Parameters:

Name	Type	Description
`xs`	*

Source:

Column.js, line 1826

Returns:

Type: boolean

(inner) of(…xs) → {ColStr|ColNum}

Parameters:

Name	Type	Attributes	Description
`xs`	*	<repeatable>

Source:

Column.js, line 1814

Returns:

array

Type: ColStr | ColNum

(inner) ones(len, dtypeopt, nullable) → {ColNum}

Parameters:

Name	Type	Attributes	Default	Description
`len`	number
`dtype`	DType	<optional> <nullable>	null

Source:

Column.js, line 1799

Returns:

array of zeros

Type: ColNum

(inner) rand(len, lBoundopt, nullable, uBoundopt, nullable, dtypeopt) → {ColNum|ColStr}

Parameters:

Name	Type	Attributes	Default
`len`	number
`lBound`	number	<optional> <nullable>	null
`uBound`	number	<optional> <nullable>	null
`dtype`	DType \| 's'	<optional>	null

Source:

Column.js, line 1758

Returns:

rand array

Type: ColNum | ColStr

(inner) range(aopt, bopt, nullable, stepopt) → {ColNum}

Parameters:

Name	Type	Attributes	Default
`a`	number	<optional>	0
`b`	number	<optional> <nullable>	null
`step`	number	<optional>	1

Source:

Column.js, line 1608

Returns:

range

Type: ColNum

(inner) repeat(len, val, dtypeopt, nullable) → {ColNum|ColStr}

Parameters:

Name	Type	Attributes	Default
`len`	number
`val`	number
`dtype`	DType	<optional> <nullable>	null

Source:

Column.js, line 1792

Returns:

array filled with value

Type: ColNum | ColStr

(inner) zeros(len, dtypeopt, nullable) → {ColNum}

By default typed arrays are filled with 0 so no need to .repeat()

Parameters:

Name	Type	Attributes	Default	Description
`len`	number
`dtype`	DType	<optional> <nullable>	null

Source:

Column.js, line 1808

Returns:

array of zeros

Type: ColNum

Type Definitions

Col

Type:

ArrayLike.<number> | ArrayLike.<string>

Properties:

Name	Type	Description
`isEmpty`	boolean
`randEl`	boolean
`BYTES_PER_ELEMENT`	number
`all`	function
`argMax`	function
`argMin`	function
`contains`	function
`counts`	function
`cum`	function
`filter`	function
`map`	function
`mode`	function
`none`	function
`some`	function
`tail`	function
`filter`	function
`print`	function
`ps`	function
`head`	function
`clone`	function
`reduce`	function
`subarray`	function
`removeAll`	function
`unique`	function
`reverse`	function
`shuffle`	function
`slice`	function
`sort`	function
`swap`	function
`takeWhile`	function
`zipWith`	function
`zipWith3`	function
`toString`	function
`dtype`	string
`length`	number

Source:

Column.js, line 19

ColNum

Type:

Properties:

Name	Type	Description
`dtype`	DType
`randEl`	number
`IQR`	function
`Q1`	function
`Q3`	function
`abs`	function
`add`	function
`cbrt`	function
`ceil`	function
`clip`	function
`concat`	function
`corr`	function
`cov`	function
`cube`	function
`disDiff`	function
`pop`	function
`distance`	function
`convert`	function
`div`	function
`dot`	function
`downcast`	function
`floor`	function
`kBins`	function
`kurtosis`	function
`mad`	function
`map`	function
`max`	function
`mean`	function
`median`	function
`memory`	function
`min`	function
`mul`	function
`nLargest`	function
`nQuart`	function
`nSmallest`	function
`normalize`	function
`pow`	function
`removeOutliers`	function
`replace`	function
`root`	function
`round`	function
`sample`	function
`skewness`	function
`smooth`	function
`sqrt`	function
`square`	function
`stdev`	function
`sub`	function
`subarray`	function
`takeWhile`	function
`trunc`	function
`var`	function

Source:

Column.js, line 69

ColStr

Type:

Properties:

Name	Type	Description
`dtype`	's'
`randEl`	string
`concat`	function
`replace`	function
`pop`	function
`labelEncode`	function
`sample`	function

Source:

Column.js, line 58

TypedArray

Type:

'i8' | 'i16' | 'i32' | 'u8' | 'u16' | 'u32' | 'f32' | 'f64'

Source:

Column.js, line 14