Class StringArray
- java.lang.Object
-
- org.apache.sysds.runtime.frame.data.columns.Array<String>
-
- org.apache.sysds.runtime.frame.data.columns.StringArray
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.sysds.runtime.frame.data.columns.Array
Array.ArrayIterator
-
-
Constructor Summary
Constructors Constructor Description StringArray(String[] data)
-
Method Summary
All Methods Instance Methods Concrete Methods 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(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<String>
append(Array<String> 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<String>
changeTypeString()
Array<String>
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 arraysboolean
containsNull()
analyze if the array contains null values.boolean
equals(Array<String> other)
void
fill(String value)
fill the entire array with specific value.String[]
get()
Get the underlying array out of the column Group, it is the responsibility of the caller to know what type it is.String
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.double
getAsNaNDouble(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.byte[]
getIndexAsBytes(int r)
Python interface to extract strings from systemds.long
getInMemorySize()
Get in memory size, not counting reference to this object.Pair<Integer,Integer>
getMinMaxLength()
Get the minimum and maximum length of the contained values as string type.BitSetArray
getNulls()
Types.ValueType
getValueType()
Get the current value type of this array.double
hashDouble(int idx)
Hash the given index of the array.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.boolean
possiblyContainsNaN()
void
readFields(DataInput in)
void
reset(int size)
Reset the Array and set to a different size.Array<String>
select(boolean[] select, int nTrue)
Slice out the true indices in the select input and return the sub array.Array<String>
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<String> value)
Set range to given arrays valuevoid
set(int rl, int ru, Array<String> value, int rlSrc)
Set range to given arrays value with an offset into other arrayvoid
set(int index, String value)
Set index to the given value of same typevoid
setFromOtherType(int rl, int ru, Array<?> value)
Set range to given arrays valuevoid
setFromOtherTypeNz(int rl, int ru, Array<?> value)
Set non default values in the range from the value array givenvoid
setNz(int rl, int ru, Array<String> value)
Set non default values in the range from the value array givenArray<String>
slice(int rl, int ru)
Slice out the sub range and return new array with the specified type.String
toString()
void
write(DataOutput out)
-
Methods inherited from class org.apache.sysds.runtime.frame.data.columns.Array
analyzeValueType, baseMemoryCost, changeType, changeType, changeTypeWithNulls, createMapping, equals, extractDouble, findEmpty, findEmptyInverse, getCache, getIterator, getRecodeMap, safeChangeType, setCache, setFromOtherTypeNz, setNz, size, statistics
-
-
-
-
Constructor Detail
-
StringArray
public StringArray(String[] data)
-
-
Method Detail
-
get
public String[] 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.
-
get
public String 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.
-
set
public void set(int index, String value)
Description copied from class:Array
Set index to the given value of same type
-
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)
-
set
public void set(int rl, int ru, Array<String> value)
Description copied from class:Array
Set range to given arrays value
-
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 classArray<String>
- Parameters:
rl
- row lowerru
- row upper (inclusive)value
- value array to take values from (other type)
-
set
public void set(int rl, int ru, Array<String> value, int rlSrc)
Description copied from class:Array
Set range to given arrays value with an offset into other array
-
setNz
public void setNz(int rl, int ru, Array<String> value)
Description copied from class:Array
Set non default values in the range from the value array given
-
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 classArray<String>
- Parameters:
rl
- row startru
- row end inclusivevalue
- 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.
-
append
public Array<String> append(Array<String> 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.
-
write
public void write(DataOutput out) throws IOException
- Throws:
IOException
-
readFields
public void readFields(DataInput in) throws IOException
- Throws:
IOException
-
clone
public Array<String> 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
-
slice
public Array<String> 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.
-
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.
-
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 classArray<String>
- Returns:
- The array as bytes
-
getIndexAsBytes
public byte[] getIndexAsBytes(int r)
Python interface to extract strings from systemds.- Parameters:
r
- the index to extract- Returns:
- The value in bytes for py4j
-
getValueType
public Types.ValueType getValueType()
Description copied from class:Array
Get the current value type of this array.- Specified by:
getValueType
in classArray<String>
- 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 classArray<String>
- 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 classArray<String>
- Returns:
- The FrameArrayType
-
getNulls
public BitSetArray getNulls()
-
getInMemorySize
public long getInMemorySize()
Description copied from class:Array
Get in memory size, not counting reference to this object.- Overrides:
getInMemorySize
in classArray<String>
- Returns:
- the size in memory of this object.
-
getExactSerializedSize
public long getExactSerializedSize()
Description copied from class:Array
Get the exact serialized size on disk of this array.- Specified by:
getExactSerializedSize
in classArray<String>
- Returns:
- The exact size on disk
-
getMinMaxLength
public Pair<Integer,Integer> getMinMaxLength()
Description copied from class:Array
Get the minimum and maximum length of the contained values as string type.- Overrides:
getMinMaxLength
in classArray<String>
- Returns:
- A Pair of first the minimum length, second the maximum length
-
fill
public void fill(String value)
Description copied from class:Array
fill the entire array with specific value.
-
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 classArray<String>
- Parameters:
i
- index to get value from- Returns:
- the value
-
getAsNaNDouble
public double getAsNaNDouble(int i)
Description copied from class:Array
Get the index's value. returns Double.NaN in case of Null.- Overrides:
getAsNaNDouble
in classArray<String>
- Parameters:
i
- index to get value from- Returns:
- the value
-
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 classArray<String>
- Returns:
- boolean saying true if shallow serialization is available
-
isEmpty
public boolean isEmpty()
Description copied from class:Array
Get if this array is empty, aka filled with empty values.
-
containsNull
public boolean containsNull()
Description copied from class:Array
analyze if the array contains null values.- Overrides:
containsNull
in classArray<String>
- Returns:
- If the array contains null.
-
select
public Array<String> select(int[] indices)
Description copied from class:Array
Slice out the specified indices and return the sub array.
-
select
public Array<String> select(boolean[] select, int nTrue)
Description copied from class:Array
Slice out the true indices in the select input and return the sub array.
-
isNotEmpty
public final boolean isNotEmpty(int i)
- Specified by:
isNotEmpty
in classArray<String>
-
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 classArray<String>
- Parameters:
idx
- The index to hash- Returns:
- The hash value of that index.
-
possiblyContainsNaN
public boolean possiblyContainsNaN()
- Specified by:
possiblyContainsNaN
in classArray<String>
-
-