Package org.apache.sysds.runtime.frame.data.columns

Class BooleanArray

java.lang.Object

org.apache.sysds.runtime.frame.data.columns.Array<Boolean>

org.apache.sysds.runtime.frame.data.columns.ABooleanArray

org.apache.sysds.runtime.frame.data.columns.BooleanArray

All Implemented Interfaces:

org.apache.hadoop.io.Writable

public class BooleanArray
extends ABooleanArray

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sysds.runtime.frame.data.columns.Array

Array.ArrayIterator

Constructor Summary

Constructors

Constructor	Description
BooleanArray(boolean[] data)

Method Summary

Modifier and Type	Method	Description
Pair<Types.ValueType,Boolean>	analyzeValueType(int maxCells)	Analyze the column to figure out if the value type can be refined to a better type.
void	append(Boolean value)	Append a value of the same type of the Array.
void	append(String value)	Append a string value to the current Array, this should in general be avoided, and appending larger blocks at a time should be preferred.
Array<Boolean>	append(Array<Boolean> other)	Append other array, if the other array is fitting in current allocated size use that allocated size, otherwise allocate new array to combine the other with this.
Array<Character>	changeTypeCharacter(Array<Character> retA, int l, int u)
ABooleanArray	clone()	Overwrite of the java internal clone function for arrays, return a clone of underlying data that is mutable, (not immutable data.) Immutable data is dependent on the individual allocated arrays
boolean	equals(Array<Boolean> other)	Equals operation on arrays.
static long	estimateInMemorySize(int nRow)
void	fill(Boolean value)	fill the entire array with specific value.
void	fill(String value)	fill the entire array with specific value.
boolean[]	get()	Get the underlying array out of the column Group, it is the responsibility of the caller to know what type it is.
Boolean	get(int index)	Get the value at a given index.
byte[]	getAsByteArray()	Return the current allocated Array as a byte[], this is used to serialize the allocated Arrays out to the PythonAPI.
double	getAsDouble(int i)	Get the index's value.
long	getExactSerializedSize()	Get the exact serialized size on disk of this array.
ArrayFactory.FrameArrayType	getFrameArrayType()	Get the internal FrameArrayType, to specify the encoding of the Types, note there are more Frame Array Types than there is ValueTypes.
long	getInMemorySize()	Get in memory size, not counting reference to this object.
Types.ValueType	getValueType()	Get the current value type of this array.
double	hashDouble(int idx)	Hash the given index of the array.
boolean	isAllTrue()
boolean	isEmpty()	Get if this array is empty, aka filled with empty values.
boolean	isNotEmpty(int i)
boolean	isShallowSerialize()	analyze if this array can be shallow serialized.
static boolean	parseBoolean(String value)
void	readFields(DataInput in)
void	reset(int size)	Reset the Array and set to a different size.
ABooleanArray	select(boolean[] select, int nTrue)	Slice out the true indices in the select input and return the sub array.
ABooleanArray	select(int[] indices)	Slice out the specified indices and return the sub array.
void	set(int index, double value)	Set index to given double value (cast to the correct type of this array)
void	set(int rl, int ru, Array<Boolean> value)	Set range to given arrays value
void	set(int rl, int ru, Array<Boolean> value, int rlSrc)	Set range to given arrays value with an offset into other array
void	set(int index, Boolean value)	Set index to the given value of same type
void	set(int index, String value)	Set index to the given value of the string parsed.
void	setFromOtherType(int rl, int ru, Array<?> value)	Set range to given arrays value
void	setFromOtherTypeNz(int rl, int ru, Array<?> value)	Set non default values in the range from the value array given
void	setNullsFromString(int rl, int ru, Array<String> value)	set boolean values in this array depending on null positions in the string array.
void	setNz(int rl, int ru, Array<Boolean> value)	Set non default values in the range from the value array given
ABooleanArray	slice(int rl, int ru)	Slice out the sub range and return new array with the specified type.
ArrayCompressionStatistics	statistics(int nSamples)	Get the compression statistics of this array allocation.
String	toString()
void	write(DataOutput out)

Methods inherited from class org.apache.sysds.runtime.frame.data.columns.ABooleanArray

possiblyContainsNaN

Methods inherited from class org.apache.sysds.runtime.frame.data.columns.Array

analyzeValueType, baseMemoryCost, changeType, changeType, changeType, changeType, changeTypeWithNulls, changeTypeWithNulls, changeTypeWithNulls, containsNull, equals, extractDouble, findEmpty, findEmptyInverse, getAsNaNDouble, getCache, getInternal, getIterator, getMinMaxLength, getNulls, getRecodeMap, minMax, minMax, setCache, setFromOtherTypeNz, setNz, size

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BooleanArray

public BooleanArray(boolean[] data)

Method Detail

get

public boolean[] get()

Description copied from class: Array

Get the underlying array out of the column Group, it is the responsibility of the caller to know what type it is. Also it is not guaranteed that the underlying data structure does not allocate an appropriate response to the caller. This in practice means that if called there is a possibility that the entire array is allocated again. So the method should only be used for debugging purposes not for performance.

Specified by:

get in class Array<Boolean>

Returns:

The underlying array.

get

public Boolean get(int index)

Description copied from class: Array

Get the value at a given index. This method returns objects that have a high overhead in allocation. Therefore it is not as efficient as using the vectorized operations specified in the object.

Specified by:

get in class Array<Boolean>

Parameters:

index - The index to query

Returns:

The value returned as an object

set

public void set(int index,
                Boolean value)

Description copied from class: Array

Set index to the given value of same type

Specified by:

set in class Array<Boolean>

Parameters:

index - The index to set

value - The value to assign

set

public void set(int index,
                double value)

Description copied from class: Array

Set index to given double value (cast to the correct type of this array)

Specified by:

set in class Array<Boolean>

Parameters:

index - the index to set

value - the value to set it to (before casting to correct value type)

set

public void set(int index,
                String value)

Description copied from class: Array

Set index to the given value of the string parsed.

Specified by:

set in class Array<Boolean>

Parameters:

index - The index to set

value - The value to assign

set

public void set(int rl,
                int ru,
                Array<Boolean> value)

Description copied from class: Array

Set range to given arrays value

Specified by:

set in class Array<Boolean>

Parameters:

rl - row lower

ru - row upper (inclusive)

value - value array to take values from (same type)

setFromOtherType

public void setFromOtherType(int rl,
                             int ru,
                             Array<?> value)

Description copied from class: Array

Set range to given arrays value

Specified by:

setFromOtherType in class Array<Boolean>

Parameters:

rl - row lower

ru - row upper (inclusive)

value - value array to take values from (other type)

set

public void set(int rl,
                int ru,
                Array<Boolean> value,
                int rlSrc)

Description copied from class: Array

Set range to given arrays value with an offset into other array

Overrides:

set in class Array<Boolean>

Parameters:

rl - row lower

ru - row upper (inclusive)

value - value array to take values from

rlSrc - the offset into the value array to take values from

setNz

public void setNz(int rl,
                  int ru,
                  Array<Boolean> value)

Description copied from class: Array

Set non default values in the range from the value array given

Specified by:

setNz in class Array<Boolean>

Parameters:

rl - row start

ru - row upper inclusive

value - value array of same type

setFromOtherTypeNz

public void setFromOtherTypeNz(int rl,
                               int ru,
                               Array<?> value)

Description copied from class: Array

Set non default values in the range from the value array given

Specified by:

setFromOtherTypeNz in class Array<Boolean>

Parameters:

rl - row start

ru - row end inclusive

value - value array of different type

append

public void append(String value)

Description copied from class: Array

Append a string value to the current Array, this should in general be avoided, and appending larger blocks at a time should be preferred.

Specified by:

append in class Array<Boolean>

Parameters:

value - The value to append

append

public void append(Boolean value)

Description copied from class: Array

Append a value of the same type of the Array. This should in general be avoided, and appending larger blocks at a time should be preferred.

Specified by:

append in class Array<Boolean>

Parameters:

value - The value to append

append

public Array<Boolean> append(Array<Boolean> other)

Description copied from class: Array

Append other array, if the other array is fitting in current allocated size use that allocated size, otherwise allocate new array to combine the other with this. This method should use the set range function, and should be preferred over the append single values.

Specified by:

append in class Array<Boolean>

Parameters:

other - The other array of same type to append to this.

Returns:

The combined arrays.

write

public void write(DataOutput out)
           throws IOException

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Throws:

IOException

clone

public ABooleanArray clone()

Description copied from class: Array

Overwrite of the java internal clone function for arrays, return a clone of underlying data that is mutable, (not immutable data.) Immutable data is dependent on the individual allocated arrays

Specified by:

clone in class ABooleanArray

Returns:

A clone

slice

public ABooleanArray slice(int rl,
                           int ru)

Description copied from class: Array

Slice out the sub range and return new array with the specified type. If the conversion fails fallback to normal slice.

Specified by:

slice in class ABooleanArray

Parameters:

rl - row start

ru - row end (not included)

Returns:

A new array of sub range.

reset

public void reset(int size)

Description copied from class: Array

Reset the Array and set to a different size. This method is used to reuse an already allocated Array, without extra allocation. It should only be done in cases where the Array is no longer in use in any FrameBlocks.

Specified by:

reset in class Array<Boolean>

Parameters:

size - The size to reallocate into.

getAsByteArray

public byte[] getAsByteArray()

Description copied from class: Array

Return the current allocated Array as a byte[], this is used to serialize the allocated Arrays out to the PythonAPI.

Specified by:

getAsByteArray in class Array<Boolean>

Returns:

The array as bytes

getValueType

public Types.ValueType getValueType()

Description copied from class: Array

Get the current value type of this array.

Specified by:

getValueType in class Array<Boolean>

Returns:

The current value type.

analyzeValueType

public Pair<Types.ValueType,Boolean> analyzeValueType(int maxCells)

Description copied from class: Array

Analyze the column to figure out if the value type can be refined to a better type. The return is in two parts, first the type it can be, second if it contains nulls.

Specified by:

analyzeValueType in class Array<Boolean>

Parameters:

maxCells - maximum number of cells to analyze

Returns:

A better or equivalent value type to represent the column, including null information.

getFrameArrayType

public ArrayFactory.FrameArrayType getFrameArrayType()

Description copied from class: Array

Get the internal FrameArrayType, to specify the encoding of the Types, note there are more Frame Array Types than there is ValueTypes.

Specified by:

getFrameArrayType in class Array<Boolean>

Returns:

The FrameArrayType

getInMemorySize

public long getInMemorySize()

Description copied from class: Array

Get in memory size, not counting reference to this object.

Overrides:

getInMemorySize in class Array<Boolean>

Returns:

the size in memory of this object.

estimateInMemorySize

public static long estimateInMemorySize(int nRow)

getExactSerializedSize

public long getExactSerializedSize()

Description copied from class: Array

Get the exact serialized size on disk of this array.

Specified by:

getExactSerializedSize in class Array<Boolean>

Returns:

The exact size on disk

changeTypeCharacter

public Array<Character> changeTypeCharacter(Array<Character> retA,
                                            int l,
                                            int u)

fill

public void fill(String value)

Description copied from class: Array

fill the entire array with specific value.

Specified by:

fill in class Array<Boolean>

Parameters:

value - the value to fill with.

fill

public void fill(Boolean value)

Description copied from class: Array

fill the entire array with specific value.

Specified by:

fill in class Array<Boolean>

Parameters:

value - the value to fill with.

isShallowSerialize

public boolean isShallowSerialize()

Description copied from class: Array

analyze if this array can be shallow serialized. to allow caching without modification.

Specified by:

isShallowSerialize in class Array<Boolean>

Returns:

boolean saying true if shallow serialization is available

getAsDouble

public double getAsDouble(int i)

Description copied from class: Array

Get the index's value. returns 0 in case of Null.

Specified by:

getAsDouble in class Array<Boolean>

Parameters:

i - index to get value from

Returns:

the value

isEmpty

public boolean isEmpty()

Description copied from class: Array

Get if this array is empty, aka filled with empty values.

Specified by:

isEmpty in class Array<Boolean>

Returns:

boolean saying true if empty

isAllTrue

public boolean isAllTrue()

Specified by:

isAllTrue in class ABooleanArray

select

public ABooleanArray select(int[] indices)

Description copied from class: Array

Slice out the specified indices and return the sub array.

Specified by:

select in class ABooleanArray

Parameters:

indices - The indices to slice out

Returns:

the sliced out indices in an array format

select

public ABooleanArray select(boolean[] select,
                            int nTrue)

Description copied from class: Array

Slice out the true indices in the select input and return the sub array.

Specified by:

select in class ABooleanArray

Parameters:

select - a boolean vector specifying what to select

nTrue - number of true values inside select

Returns:

the sliced out indices in an array format

isNotEmpty

public final boolean isNotEmpty(int i)

Specified by:

isNotEmpty in class Array<Boolean>

parseBoolean

public static boolean parseBoolean(String value)

hashDouble

public double hashDouble(int idx)

Description copied from class: Array

Hash the given index of the array. It is allowed to return NaN on null elements.

Specified by:

hashDouble in class Array<Boolean>

Parameters:

idx - The index to hash

Returns:

The hash value of that index.

setNullsFromString

public void setNullsFromString(int rl,
                               int ru,
                               Array<String> value)

Description copied from class: ABooleanArray

set boolean values in this array depending on null positions in the string array.

Specified by:

setNullsFromString in class ABooleanArray

Parameters:

rl - Inclusive lower bound

ru - Exclusive upper bound

value - The string array to set from.

statistics

public ArrayCompressionStatistics statistics(int nSamples)

Description copied from class: Array

Get the compression statistics of this array allocation.

Overrides:

statistics in class Array<Boolean>

Parameters:

nSamples - The number of sample elements suggested (not forced) to be used.

Returns:

The compression statistics of this array.

equals

public boolean equals(Array<Boolean> other)

Description copied from class: Array

Equals operation on arrays.

Specified by:

equals in class Array<Boolean>

Parameters:

other - The other array to compare to.

Returns:

True if the arrays are equivalent.

toString

public String toString()

Overrides:

toString in class Array<Boolean>