LibSVMSaver (original) (raw)

java.lang.Object
- weka.core.converters.AbstractSaver
- - weka.core.converters.AbstractFileSaver
    - - weka.core.converters.LibSVMSaver
All Implemented Interfaces:
java.io.Serializable, CapabilitiesHandler, BatchConverter, FileSourcedConverter, IncrementalConverter, Saver, EnvironmentHandler, OptionHandler, RevisionHandler

public class LibSVMSaver
extends AbstractFileSaver
implements BatchConverter, IncrementalConverter
Writes to a destination that is in libsvm format.
For more information about libsvm see:
http://www.csie.ntu.edu.tw/\~cjlin/libsvm/
Valid options are:
-i
The input file
-o
The output file
-c
The class index
(default: last)
Version: Revision:8011Revision: 8011 Revision:8011
Author:
FracPete (fracpete at waikato dot ac dot nz)
See Also:
Saver, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_EXTENSION the file extension

   * ### Fields inherited from interface weka.core.converters.[Saver](../../../weka/core/converters/Saver.html "interface in weka.core.converters")  
   `[BATCH](../../../weka/core/converters/Saver.html#BATCH), [INCREMENTAL](../../../weka/core/converters/Saver.html#INCREMENTAL), [NONE](../../../weka/core/converters/Saver.html#NONE)`

Constructor Summary

Constructors

Constructor and Description
LibSVMSaver() Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method and Description
java.lang.String	classIndexTipText() Returns the tip text for this property
Capabilities	getCapabilities() Returns the Capabilities of this saver.
java.lang.String	getClassIndex() Get the index of the class attribute.
java.lang.String	getFileDescription() Returns a description of the file type.
java.lang.String[]	getOptions() returns the options of the current setup
java.lang.String	getRevision() Returns the revision string.
java.lang.String	globalInfo() Returns a string describing this Saver
java.util.Enumeration	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method.
void	resetOptions() Resets the Saver
void	setClassIndex(java.lang.String value) Sets index of the class attribute.
void	setInstances(Instances instances) Sets instances that should be stored.
void	setOptions(java.lang.String[] options) Parses the options for this object.
void	writeBatch() Writes a Batch of instances
void	writeIncremental(Instance inst) Saves an instances incrementally.

   * ### Methods inherited from class weka.core.converters.[AbstractFileSaver](../../../weka/core/converters/AbstractFileSaver.html "class in weka.core.converters")  
   `[cancel](../../../weka/core/converters/AbstractFileSaver.html#cancel--), [filePrefix](../../../weka/core/converters/AbstractFileSaver.html#filePrefix--), [getFileExtension](../../../weka/core/converters/AbstractFileSaver.html#getFileExtension--), [getFileExtensions](../../../weka/core/converters/AbstractFileSaver.html#getFileExtensions--), [getUseRelativePath](../../../weka/core/converters/AbstractFileSaver.html#getUseRelativePath--), [getWriter](../../../weka/core/converters/AbstractFileSaver.html#getWriter--), [resetWriter](../../../weka/core/converters/AbstractFileSaver.html#resetWriter--), [retrieveDir](../../../weka/core/converters/AbstractFileSaver.html#retrieveDir--), [retrieveFile](../../../weka/core/converters/AbstractFileSaver.html#retrieveFile--), [runFileSaver](../../../weka/core/converters/AbstractFileSaver.html#runFileSaver-weka.core.converters.AbstractFileSaver-java.lang.String:A-), [setDestination](../../../weka/core/converters/AbstractFileSaver.html#setDestination-java.io.File-), [setDestination](../../../weka/core/converters/AbstractFileSaver.html#setDestination-java.io.OutputStream-), [setDir](../../../weka/core/converters/AbstractFileSaver.html#setDir-java.lang.String-), [setDirAndPrefix](../../../weka/core/converters/AbstractFileSaver.html#setDirAndPrefix-java.lang.String-java.lang.String-), [setEnvironment](../../../weka/core/converters/AbstractFileSaver.html#setEnvironment-weka.core.Environment-), [setFile](../../../weka/core/converters/AbstractFileSaver.html#setFile-java.io.File-), [setFilePrefix](../../../weka/core/converters/AbstractFileSaver.html#setFilePrefix-java.lang.String-), [setUseRelativePath](../../../weka/core/converters/AbstractFileSaver.html#setUseRelativePath-boolean-), [useRelativePathTipText](../../../weka/core/converters/AbstractFileSaver.html#useRelativePathTipText--)`  
   * ### Methods inherited from class weka.core.converters.[AbstractSaver](../../../weka/core/converters/AbstractSaver.html "class in weka.core.converters")  
   `[getInstances](../../../weka/core/converters/AbstractSaver.html#getInstances--), [getWriteMode](../../../weka/core/converters/AbstractSaver.html#getWriteMode--), [resetStructure](../../../weka/core/converters/AbstractSaver.html#resetStructure--), [setRetrieval](../../../weka/core/converters/AbstractSaver.html#setRetrieval-int-), [setStructure](../../../weka/core/converters/AbstractSaver.html#setStructure-weka.core.Instances-)`  
   * ### Methods inherited from class java.lang.Object  
   `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

 * #### FILE\_EXTENSION  
 public static java.lang.String FILE_EXTENSION  
 the file extension

Constructor Detail

* #### LibSVMSaver  
public LibSVMSaver()  
Constructor

Method Detail

* #### globalInfo  
public java.lang.String globalInfo()  
Returns a string describing this Saver  
Returns:  
a description of the Saver suitable for displaying in the explorer/experimenter gui  
* #### listOptions  
public java.util.Enumeration listOptions()  
Returns an enumeration describing the available options.  
Specified by:  
`[listOptions](../../../weka/core/OptionHandler.html#listOptions--)` in interface `[OptionHandler](../../../weka/core/OptionHandler.html "interface in weka.core")`  
Overrides:  
`[listOptions](../../../weka/core/converters/AbstractFileSaver.html#listOptions--)` in class `[AbstractFileSaver](../../../weka/core/converters/AbstractFileSaver.html "class in weka.core.converters")`  
Returns:  
an enumeration of all the available options.  
* #### getOptions  
public java.lang.String[] getOptions()  
returns the options of the current setup  
Specified by:  
`[getOptions](../../../weka/core/OptionHandler.html#getOptions--)` in interface `[OptionHandler](../../../weka/core/OptionHandler.html "interface in weka.core")`  
Overrides:  
`[getOptions](../../../weka/core/converters/AbstractFileSaver.html#getOptions--)` in class `[AbstractFileSaver](../../../weka/core/converters/AbstractFileSaver.html "class in weka.core.converters")`  
Returns:  
the current options  
* #### setOptions  
public void setOptions(java.lang.String[] options)  
                throws java.lang.Exception  
Parses the options for this object.  
 Valid options are:  
 -i <the input file>  
  The input file  
 -o <the output file>  
  The output file  
 -c <class index>  
  The class index  
  (default: last)  
Specified by:  
`[setOptions](../../../weka/core/OptionHandler.html#setOptions-java.lang.String:A-)` in interface `[OptionHandler](../../../weka/core/OptionHandler.html "interface in weka.core")`  
Overrides:  
`[setOptions](../../../weka/core/converters/AbstractFileSaver.html#setOptions-java.lang.String:A-)` in class `[AbstractFileSaver](../../../weka/core/converters/AbstractFileSaver.html "class in weka.core.converters")`  
Parameters:  
`options` \- the options to use  
Throws:  
`java.lang.Exception` \- if setting of options fails  
* #### getFileDescription  
public java.lang.String getFileDescription()  
Returns a description of the file type.  
Specified by:  
`[getFileDescription](../../../weka/core/converters/FileSourcedConverter.html#getFileDescription--)` in interface `[FileSourcedConverter](../../../weka/core/converters/FileSourcedConverter.html "interface in weka.core.converters")`  
Specified by:  
`[getFileDescription](../../../weka/core/converters/AbstractFileSaver.html#getFileDescription--)` in class `[AbstractFileSaver](../../../weka/core/converters/AbstractFileSaver.html "class in weka.core.converters")`  
Returns:  
a short file description  
* #### resetOptions  
public void resetOptions()  
Resets the Saver  
Overrides:  
`[resetOptions](../../../weka/core/converters/AbstractFileSaver.html#resetOptions--)` in class `[AbstractFileSaver](../../../weka/core/converters/AbstractFileSaver.html "class in weka.core.converters")`  
* #### classIndexTipText  
public java.lang.String classIndexTipText()  
Returns the tip text for this property  
Returns:  
tip text for this property suitable for displaying in the explorer/experimenter gui  
* #### getClassIndex  
public java.lang.String getClassIndex()  
Get the index of the class attribute.  
Returns:  
the index of the class attribute  
* #### setClassIndex  
public void setClassIndex(java.lang.String value)  
Sets index of the class attribute.  
Parameters:  
`value` \- the index of the class attribute  
* #### getCapabilities  
public [Capabilities](../../../weka/core/Capabilities.html "class in weka.core") getCapabilities()  
Returns the Capabilities of this saver.  
Specified by:  
`[getCapabilities](../../../weka/core/CapabilitiesHandler.html#getCapabilities--)` in interface `[CapabilitiesHandler](../../../weka/core/CapabilitiesHandler.html "interface in weka.core")`  
Overrides:  
`[getCapabilities](../../../weka/core/converters/AbstractSaver.html#getCapabilities--)` in class `[AbstractSaver](../../../weka/core/converters/AbstractSaver.html "class in weka.core.converters")`  
Returns:  
the capabilities of this object  
See Also:  
[Capabilities](../../../weka/core/Capabilities.html "class in weka.core")  
* #### setInstances  
public void setInstances([Instances](../../../weka/core/Instances.html "class in weka.core") instances)  
Sets instances that should be stored.  
Specified by:  
`[setInstances](../../../weka/core/converters/Saver.html#setInstances-weka.core.Instances-)` in interface `[Saver](../../../weka/core/converters/Saver.html "interface in weka.core.converters")`  
Overrides:  
`[setInstances](../../../weka/core/converters/AbstractSaver.html#setInstances-weka.core.Instances-)` in class `[AbstractSaver](../../../weka/core/converters/AbstractSaver.html "class in weka.core.converters")`  
Parameters:  
`instances` \- the instances  
* #### writeIncremental  
public void writeIncremental([Instance](../../../weka/core/Instance.html "class in weka.core") inst)  
                      throws java.io.IOException  
Saves an instances incrementally. Structure has to be set by using the setStructure() method or setInstances() method.  
Specified by:  
`[writeIncremental](../../../weka/core/converters/Saver.html#writeIncremental-weka.core.Instance-)` in interface `[Saver](../../../weka/core/converters/Saver.html "interface in weka.core.converters")`  
Overrides:  
`[writeIncremental](../../../weka/core/converters/AbstractSaver.html#writeIncremental-weka.core.Instance-)` in class `[AbstractSaver](../../../weka/core/converters/AbstractSaver.html "class in weka.core.converters")`  
Parameters:  
`inst` \- the instance to save  
Throws:  
`java.io.IOException` \- throws IOEXception if an instance cannot be saved incrementally.  
* #### writeBatch  
public void writeBatch()  
                throws java.io.IOException  
Writes a Batch of instances  
Specified by:  
`[writeBatch](../../../weka/core/converters/Saver.html#writeBatch--)` in interface `[Saver](../../../weka/core/converters/Saver.html "interface in weka.core.converters")`  
Specified by:  
`[writeBatch](../../../weka/core/converters/AbstractSaver.html#writeBatch--)` in class `[AbstractSaver](../../../weka/core/converters/AbstractSaver.html "class in weka.core.converters")`  
Throws:  
`java.io.IOException` \- throws IOException if saving in batch mode is not possible  
* #### getRevision  
public java.lang.String getRevision()  
Returns the revision string.  
Specified by:  
`[getRevision](../../../weka/core/RevisionHandler.html#getRevision--)` in interface `[RevisionHandler](../../../weka/core/RevisionHandler.html "interface in weka.core")`  
Returns:  
the revision  
* #### main  
public static void main(java.lang.String[] args)  
Main method.  
Parameters:  
`args` \- should contain the options of a Saver.

LibSVMSaver (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail