src/Lucene.Net.Classification/ClassificationResult.cs

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Lucene.Net.Classification
{
    /// <summary>
    /// The result of a call to {@link Classifier#assignClass(String)} holding an assigned class of type <code>T</code> and a score.
    /// @lucene.experimental
    /// </summary>
    public class ClassificationResult<T>
    {

        private readonly T _assignedClass;
        private readonly double _score;

        /// <summary>
        /// Constructor
        /// <param name="assignedClass">assignedClass the class <code>T</code> assigned by a {@link Classifier}</param>
        /// <param name="score">score the score for the assignedClass as a <code>double</code></param>
        /// </summary>
        public ClassificationResult(T assignedClass, double score) 
        {
            _assignedClass = assignedClass;
            _score = score;
        }

        /// <summary>
        /// retrieve the result class
        /// @return a <code>T</code> representing an assigned class
        /// </summary>
        public T AssignedClass 
        {
            get
            {
                return _assignedClass;
            }
        }

        /// <summary>
        /// retrieve the result score
        /// @return a <code>double</code> representing a result score
        /// </summary>
        public double Score
        {
            get
            {
                return _score;
            }
        }
    }
}