smile.data

Class Dataset<E>

java.lang.Object

smile.data.Dataset<E>

Type Parameters:

E - the type of data objects.

All Implemented Interfaces:

Iterable<Datum<E>>

Direct Known Subclasses:

AttributeDataset, BinarySparseDataset

public class Dataset<E>
extends Object
implements Iterable<Datum<E>>

A set of data objects.

Author:

Haifeng Li

Constructor Summary

Constructors

Constructor and Description
Dataset() Constructor.
Dataset(Attribute response) Constructor.
Dataset(String name) Constructor.
Dataset(String name, Attribute response) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Datum<E> x) Add a datum item into the dataset.
void	add(E x) Add a datum item into the dataset.
void	add(E x, double y) Add a datum item into the dataset.
void	add(E x, double y, double weight) Add a datum item into the dataset.
void	add(E x, int y) Add a datum item into the dataset.
void	add(E x, int y, double weight) Add a datum item into the dataset.
Datum<E>	get(int i) Returns the element at the specified position in this dataset.
String	getDescription() Returns the detailed dataset description.
String	getName() Returns the dataset name.
Iterator<Datum<E>>	iterator() Returns an iterator over the elements in this dataset in proper sequence.
Datum<E>	remove(int i) Removes the element at the specified position in this dataset.
Attribute	response() Returns the attribute of the response variable.
void	setDescription(String description) Sets the detailed dataset description.
void	setName(String name) Sets the dataset name.
int	size() Returns the size of dataset.
double[]	toArray(double[] a) Returns an array containing the response variable of the elements in this dataset in proper sequence (from first to last element).
E[]	toArray(E[] a) Returns an array containing all of the elements in this dataset in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
int[]	toArray(int[] a) Returns an array containing the class labels of the elements in this dataset in proper sequence (from first to last element).
String[]	toArray(String[] a) Returns an array containing the string names of the elements in this dataset in proper sequence (from first to last element).
Timestamp[]	toArray(Timestamp[] a) Returns an array containing the timestamps of the elements in this dataset in proper sequence (from first to last element).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Dataset

public Dataset()

Constructor.

Dataset

public Dataset(String name)

Constructor.

Parameters:

name - the name of dataset.

Dataset

public Dataset(Attribute response)

Constructor.

Parameters:

response - the attribute type of response variable.

Dataset

public Dataset(String name,
       Attribute response)

Constructor.

Parameters:

name - the name of dataset.

response - the attribute type of response variable.

Method Detail

getName

public String getName()

Returns the dataset name.

setName

public void setName(String name)

Sets the dataset name.

setDescription

public void setDescription(String description)

Sets the detailed dataset description.

getDescription

public String getDescription()

Returns the detailed dataset description.

response

public Attribute response()

Returns the attribute of the response variable. null means no response variable in this dataset.

Returns:

the attribute of the response variable. null means no response variable in this dataset.

size

public int size()

Returns the size of dataset.

add

public void add(Datum<E> x)

Add a datum item into the dataset.

Parameters:

x - a datum item.

add

public void add(E x)

Add a datum item into the dataset.

Parameters:

x - a datum item.

add

public void add(E x,
       int y)

Add a datum item into the dataset.

Parameters:

x - a datum item.

y - the class label of the datum.

add

public void add(E x,
       int y,
       double weight)

Add a datum item into the dataset.

Parameters:

x - a datum item.

y - the class label of the datum.

weight - the weight of datum. The particular meaning of weight depends on applications and machine learning algorithms. Although there are on explicit requirements on the weights, in general, they should be positive.

add

public void add(E x,
       double y)

Add a datum item into the dataset.

Parameters:

x - a datum item.

y - the real-valued response for regression.

add

public void add(E x,
       double y,
       double weight)

Add a datum item into the dataset.

Parameters:

x - a datum item.

weight - the weight of datum. The particular meaning of weight depends on applications and machine learning algorithms. Although there are on explicit requirements on the weights, in general, they should be positive.

remove

public Datum<E> remove(int i)

Removes the element at the specified position in this dataset.

Parameters:

i - the index of the element to be removed.

Returns:

the element previously at the specified position.

get

public Datum<E> get(int i)

Returns the element at the specified position in this dataset.

Parameters:

i - the index of the element to be returned.

iterator

public Iterator<Datum<E>> iterator()

Returns an iterator over the elements in this dataset in proper sequence.

Specified by:

iterator in interface Iterable<Datum<E>>

Returns:

an iterator over the elements in this dataset in proper sequence

toArray

public E[] toArray(E[] a)

Returns an array containing all of the elements in this dataset in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the dataset fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this dataset.

If the dataset fits in the specified array with room to spare (i.e., the array has more elements than the dataset), the element in the array immediately following the end of the dataset is set to null.

Parameters:

a - the array into which the elements of this dataset are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this list.

toArray

public int[] toArray(int[] a)

Returns an array containing the class labels of the elements in this dataset in proper sequence (from first to last element). Unknown labels will be saved as Integer.MIN_VALUE. If the dataset fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the size of this dataset.

If the dataset fits in the specified array with room to spare (i.e., the array has more elements than the dataset), the element in the array immediately following the end of the dataset is set to Integer.MIN_VALUE.

Parameters:

a - the array into which the class labels of this dataset are to be stored, if it is big enough; otherwise, a new array is allocated for this purpose.

Returns:

an array containing the class labels of this dataset.

toArray

public double[] toArray(double[] a)

Returns an array containing the response variable of the elements in this dataset in proper sequence (from first to last element). If the dataset fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the size of this dataset.

If the dataset fits in the specified array with room to spare (i.e., the array has more elements than the dataset), the element in the array immediately following the end of the dataset is set to Double.NaN.

Parameters:

a - the array into which the response variable of this dataset are to be stored, if it is big enough; otherwise, a new array is allocated for this purpose.

Returns:

an array containing the response variable of this dataset.

toArray

public String[] toArray(String[] a)

Returns an array containing the string names of the elements in this dataset in proper sequence (from first to last element). If the dataset fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the size of this dataset.

If the dataset fits in the specified array with room to spare (i.e., the array has more elements than the dataset), the element in the array immediately following the end of the dataset is set to null.

Parameters:

a - the array into which the string names of the elements in this dataset are to be stored, if it is big enough; otherwise, a new array is allocated for this purpose.

Returns:

an array containing the string names of the elements in this dataset.

toArray

public Timestamp[] toArray(Timestamp[] a)

Returns an array containing the timestamps of the elements in this dataset in proper sequence (from first to last element). If the dataset fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the size of this dataset.

If the dataset fits in the specified array with room to spare (i.e., the array has more elements than the dataset), the element in the array immediately following the end of the dataset is set to null.

Parameters:

a - the array into which the timestamps of the elements in this dataset are to be stored, if it is big enough; otherwise, a new array is allocated for this purpose.

Returns:

an array containing the timestamps of the elements in this dataset.