## Uses of Class
org.apache.lucene.classification.ClassificationResult

- Packages that use ClassificationResult
  Package | Description
  --- | ---
  org.apache.lucene.classification | Uses already seen data (the indexed documents) to classify an input ( can be simple text or a structured document).
  org.apache.lucene.classification.document | Uses already seen data (the indexed documents) to classify new documents.

- - ### Uses of ClassificationResult in org.apache.lucene.classification

    Methods in org.apache.lucene.classification that return ClassificationResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClassificationResult<BytesRef>` | BM25NBClassifier.`assignClass​(String inputDocument)` |
    `ClassificationResult<Boolean>` | BooleanPerceptronClassifier.`assignClass​(String text)` |
    `ClassificationResult<T>` | Classifier.`assignClass​(String text)` | Assign a class (with score) to the given text String
    `ClassificationResult<BytesRef>` | KNearestFuzzyClassifier.`assignClass​(String text)` |
    `ClassificationResult<BytesRef>` | KNearestNeighborClassifier.`assignClass​(String text)` |
    `ClassificationResult<BytesRef>` | SimpleNaiveBayesClassifier.`assignClass​(String inputDocument)` |
    `protected ClassificationResult<BytesRef>` | KNearestNeighborClassifier.`classifyFromTopDocs​(TopDocs knnResults)` | TODO

    Methods in org.apache.lucene.classification that return types with arguments of type ClassificationResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected List<ClassificationResult<BytesRef>>` | CachingNaiveBayesClassifier.`assignClassNormalizedList​(String inputDocument)` | Transforms values into a range between 0 and 1
    `protected List<ClassificationResult<BytesRef>>` | SimpleNaiveBayesClassifier.`assignClassNormalizedList​(String inputDocument)` | Calculate probabilities for all classes for a given input text
    `protected List<ClassificationResult<BytesRef>>` | KNearestNeighborClassifier.`buildListFromTopDocs​(TopDocs topDocs)` | build a list of classification results from search results
    `List<ClassificationResult<BytesRef>>` | BM25NBClassifier.`getClasses​(String text)` |
    `List<ClassificationResult<BytesRef>>` | BM25NBClassifier.`getClasses​(String text, int max)` |
    `List<ClassificationResult<Boolean>>` | BooleanPerceptronClassifier.`getClasses​(String text)` |
    `List<ClassificationResult<Boolean>>` | BooleanPerceptronClassifier.`getClasses​(String text, int max)` |
    `List<ClassificationResult<T>>` | Classifier.`getClasses​(String text)` | Get all the classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<T>>` | Classifier.`getClasses​(String text, int max)` | Get the first `max` classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<BytesRef>>` | KNearestFuzzyClassifier.`getClasses​(String text)` |
    `List<ClassificationResult<BytesRef>>` | KNearestFuzzyClassifier.`getClasses​(String text, int max)` |
    `List<ClassificationResult<BytesRef>>` | KNearestNeighborClassifier.`getClasses​(String text)` |
    `List<ClassificationResult<BytesRef>>` | KNearestNeighborClassifier.`getClasses​(String text, int max)` |
    `List<ClassificationResult<BytesRef>>` | SimpleNaiveBayesClassifier.`getClasses​(String text)` |
    `List<ClassificationResult<BytesRef>>` | SimpleNaiveBayesClassifier.`getClasses​(String text, int max)` |
    `protected ArrayList<ClassificationResult<BytesRef>>` | SimpleNaiveBayesClassifier.`normClassificationResults​(List<ClassificationResult<BytesRef>> assignedClasses)` | Normalize the classification results based on the max score available

    Methods in org.apache.lucene.classification with parameters of type ClassificationResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `int` | ClassificationResult.`compareTo​(ClassificationResult<T> o)` |

    Method parameters in org.apache.lucene.classification with type arguments of type ClassificationResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected ArrayList<ClassificationResult<BytesRef>>` | SimpleNaiveBayesClassifier.`normClassificationResults​(List<ClassificationResult<BytesRef>> assignedClasses)` | Normalize the classification results based on the max score available

  - ### Uses of ClassificationResult in org.apache.lucene.classification.document

    Methods in org.apache.lucene.classification.document that return ClassificationResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClassificationResult<T>` | DocumentClassifier.`assignClass​(Document document)` | Assign a class (with score) to the given `Document`
    `ClassificationResult<BytesRef>` | KNearestNeighborDocumentClassifier.`assignClass​(Document document)` |
    `ClassificationResult<BytesRef>` | SimpleNaiveBayesDocumentClassifier.`assignClass​(Document document)` |

    Methods in org.apache.lucene.classification.document that return types with arguments of type ClassificationResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `List<ClassificationResult<T>>` | DocumentClassifier.`getClasses​(Document document)` | Get all the classes (sorted by score, descending) assigned to the given `Document`.
    `List<ClassificationResult<T>>` | DocumentClassifier.`getClasses​(Document document, int max)` | Get the first `max` classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<BytesRef>>` | KNearestNeighborDocumentClassifier.`getClasses​(Document document)` |
    `List<ClassificationResult<BytesRef>>` | KNearestNeighborDocumentClassifier.`getClasses​(Document document, int max)` |
    `List<ClassificationResult<BytesRef>>` | SimpleNaiveBayesDocumentClassifier.`getClasses​(Document document)` |
    `List<ClassificationResult<BytesRef>>` | SimpleNaiveBayesDocumentClassifier.`getClasses​(Document document, int max)` |