RecallRanklistComputation.cs

Go to the documentation of this file.

// TraceLab Component Library
// Copyright © 2012-2013 SEMERU
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

using System.Linq;
using TraceLabSDK.Types;
using TraceLabSDK.Types.Contests;

namespace TraceLab.Components.DevelopmentKit.Metrics.Traceability
{
    public class RecallRanklistComputation : MetricComputation
    {
        #region Members

        private const string _name = "Recall (ranklist granularity)";
        private const string _description = "Recall measures the fraction of correctly retrieved documents among the total correct documents. This metric is computed on the overall ranked list.";

        public override string Name
        {
            get { return _name; }
        }

        public override string Description
        {
            get { return _description; }
        }

        private TLSimilarityMatrix _matrix;
        private TLSimilarityMatrix _oracle;

        #endregion

        public RecallRanklistComputation(TLSimilarityMatrix candidateMatrix, TLSimilarityMatrix answerMatrix)
        {
            _matrix = candidateMatrix;
            _oracle = answerMatrix;
        }

        protected override void ComputeImplementation()
        {
            _oracle.Threshold = 0;
            int correct = 0;
            foreach (TLSingleLink link in _matrix.AllLinks)
            {
                if (_oracle.IsLinkAboveThreshold(link.SourceArtifactId, link.TargetArtifactId))
                {
                    correct++;
                }
            }
            Results = new TraceLabSDK.SerializableDictionary<string,double>();
            Results.Add("Recall", correct / (double)_oracle.Count);
        }

        protected override Metric GenerateSummaryImplementation()
        {
            BoxSummaryData data = new BoxSummaryData(Name, Description);
            data.AddPoint(new BoxPlotPoint(Results.Values.ToArray()));
            return data;
        }
    }
}