Examples (DL-Learner Javadoc)

java.lang.Object
- org.dllearner.experiments.Examples

```
public class Examples
extends Object
```
a container for examples used for operations like randomization

Author:

Sebastian Hellmann

Field Summary

Fields
Modifier and Type Field and Description

static DecimalFormat df1

static DecimalFormat df2

static DecimalFormat df3

Fields
Modifier and Type	Field and Description
`static DecimalFormat`	`df1`
`static DecimalFormat`	`df2`
`static DecimalFormat`	`df3`

Constructor Summary

Constructors
Constructor and Description
`Examples()` default constructor
`Examples(SortedSet<String> posTrain, SortedSet<String> negTrain)` constructor to add training examples
`Examples(SortedSet<String> posTrain, SortedSet<String> negTrain, SortedSet<String> posTest, SortedSet<String> negTest)` adds all examples, doublettes are removed automatically

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNegTest(Collection<String> neg)`
`void`	`addNegTest(String neg)`
`void`	`addNegTrain(Collection<String> neg)`
`void`	`addNegTrain(String neg)`
`void`	`addPosTest(Collection<String> pos)`
`void`	`addPosTest(String pos)`
`void`	`addPosTrain(Collection<String> pos)`
`void`	`addPosTrain(String pos)`
`boolean`	`checkConsistency()`
`SortedSet<String>`	`getAllExamples()`
`SortedSet<String>`	`getNegativeExamples()`
`SortedSet<String>`	`getNegTest()`
`SortedSet<String>`	`getNegTrain()`
`SortedSet<String>`	`getPositiveExamples()`
`SortedSet<String>`	`getPosTest()`
`SortedSet<String>`	`getPosTrain()`
`SortedSet<String>`	`getTestExamples()`
`SortedSet<String>`	`getTrainExamples()`
`double`	`precision(SortedSet<String> retrieved)` calculates precision based on the test set removes all training data from retrieved first
`double`	`recall(SortedSet<String> retrieved)` calculates recall based on the test set
`int`	`size()` sum of training and test data
`int`	`sizeOfTestSets()`
`int`	`sizeOfTrainingSets()`
`int`	`sizeTotalOfNegatives()`
`int`	`sizeTotalOfPositives()`
`String`	`toFullString()`
`String`	`toString()`
`void`	`writeExamples(String filename)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

df1
```
public static DecimalFormat df1
```

df2
```
public static DecimalFormat df2
```

df3
```
public static DecimalFormat df3
```

Constructor Detail

Examples
```
public Examples()
```
default constructor

Examples

public Examples(SortedSet<String> posTrain,
                SortedSet<String> negTrain)

constructor to add training examples

Parameters:: posTrain -; negTrain -

Examples

public Examples(SortedSet<String> posTrain,
                SortedSet<String> negTrain,
                SortedSet<String> posTest,
                SortedSet<String> negTest)

adds all examples, doublettes are removed automatically

Parameters:: posTrain -; negTrain -; posTest -; negTest -

Method Detail

precision
```
public double precision(SortedSet<String> retrieved)
```
calculates precision based on the test set removes all training data from retrieved first

Parameters:

retrieved -

Returns:

recall
```
public double recall(SortedSet<String> retrieved)
```
calculates recall based on the test set

Parameters:

retrieved -

Returns:

addPosTrain

public void addPosTrain(Collection<String> pos)

addPosTest

public void addPosTest(Collection<String> pos)

addNegTrain

public void addNegTrain(Collection<String> neg)

addNegTest

public void addNegTest(Collection<String> neg)

addPosTrain
```
public void addPosTrain(String pos)
```

addPosTest
```
public void addPosTest(String pos)
```

addNegTrain
```
public void addNegTrain(String neg)
```

addNegTest
```
public void addNegTest(String neg)
```

checkConsistency
```
public boolean checkConsistency()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

toFullString
```
public String toFullString()
```

writeExamples

public void writeExamples(String filename)

size
```
public int size()
```
sum of training and test data

Returns:

sizeTotalOfPositives
```
public int sizeTotalOfPositives()
```

sizeTotalOfNegatives
```
public int sizeTotalOfNegatives()
```

sizeOfTrainingSets
```
public int sizeOfTrainingSets()
```

sizeOfTestSets
```
public int sizeOfTestSets()
```

getAllExamples

public SortedSet<String> getAllExamples()

getPositiveExamples

public SortedSet<String> getPositiveExamples()

getNegativeExamples

public SortedSet<String> getNegativeExamples()

getTestExamples

public SortedSet<String> getTestExamples()

getTrainExamples

public SortedSet<String> getTrainExamples()

getPosTrain

public SortedSet<String> getPosTrain()

getNegTrain

public SortedSet<String> getNegTrain()

getPosTest
```
public SortedSet<String> getPosTest()
```

getNegTest
```
public SortedSet<String> getNegTest()
```

Class Examples

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

df1

df2

df3

Constructor Detail

Examples

Examples

Examples

Method Detail

precision

recall

addPosTrain

addPosTest

addNegTrain

addNegTest

addPosTrain

addPosTest

addNegTrain

addNegTest

checkConsistency

toString

toFullString

writeExamples

size

sizeTotalOfPositives

sizeTotalOfNegatives

sizeOfTrainingSets

sizeOfTestSets

getAllExamples

getPositiveExamples

getNegativeExamples

getTestExamples

getTrainExamples

getPosTrain

getNegTrain

getPosTest

getNegTest