## 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 and Description
    --- | ---
    `ClassificationResult<BytesRef>` | KNearestNeighborClassifier.`assignClass(String text)` Assign a class (with score) to the given text String
    `ClassificationResult<T>` | Classifier.`assignClass(String text)` Assign a class (with score) to the given text String
    `ClassificationResult<Boolean>` | BooleanPerceptronClassifier.`assignClass(String text)` Assign a class (with score) to the given text String
    `ClassificationResult<BytesRef>` | SimpleNaiveBayesClassifier.`assignClass(String inputDocument)` Assign a class (with score) to the given text String

    Methods in org.apache.lucene.classification that return types with arguments of type ClassificationResult
    Modifier and Type | Method and Description
    --- | ---
    `protected List<ClassificationResult<BytesRef>>` | CachingNaiveBayesClassifier.`assignClassNormalizedList(String inputDocument)`
    `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>>` | KNearestNeighborClassifier.`getClasses(String text)` Get all the classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<T>>` | Classifier.`getClasses(String text)` Get all the classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<Boolean>>` | BooleanPerceptronClassifier.`getClasses(String text)` Get all the classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<BytesRef>>` | SimpleNaiveBayesClassifier.`getClasses(String text)` Get all the classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<BytesRef>>` | KNearestNeighborClassifier.`getClasses(String text, int max)` Get the first `max` 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<Boolean>>` | BooleanPerceptronClassifier.`getClasses(String text, int max)` Get the first `max` classes (sorted by score, descending) assigned to the given text String.
    `List<ClassificationResult<BytesRef>>` | SimpleNaiveBayesClassifier.`getClasses(String text, int max)` Get the first `max` classes (sorted by score, descending) assigned to the given text String.
    `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 and Description
    --- | ---
    `int` | ClassificationResult.`compareTo(ClassificationResult<T> o)`

    Method parameters in org.apache.lucene.classification with type arguments of type ClassificationResult
    Modifier and Type | Method and 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 and Description
    --- | ---
    `ClassificationResult<T>` | DocumentClassifier.`assignClass(Document document)` Assign a class (with score) to the given `Document`
    `ClassificationResult<BytesRef>` | SimpleNaiveBayesDocumentClassifier.`assignClass(Document document)` Assign a class (with score) to the given `Document`
    `ClassificationResult<BytesRef>` | KNearestNeighborDocumentClassifier.`assignClass(Document document)` Assign a class (with score) to the given `Document`

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

Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.