Ticket #2944: CustomHVAnalyzer.cs

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab 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.
 *
 * HeuristicLab 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 HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Linq;

using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.Problems.TestFunctions.MultiObjective;

namespace HeuristicLab.Analysis {
//namespace HeuristicLab.Problems.TestFunctions.MultiObjective {

    [StorableClass]
  public class CustomHVAnalyzer : SingleSuccessorOperator, IAnalyzer, IMultiObjectiveOperator {
    public virtual bool EnabledByDefault { get { return true; } }

    public ILookupParameter<BoolArray> MaximizationParameter {
        get { return (ILookupParameter<BoolArray>)Parameters["Maximization"]; }
    }

    //parameters from MOTFAnalyzer
        public IScopeTreeLookupParameter<DoubleArray> QualitiesParameter {
        get { return (IScopeTreeLookupParameter<DoubleArray>)Parameters["Qualities"]; }
    }

    public ILookupParameter<ResultCollection> ResultsParameter {
        get { return (ILookupParameter<ResultCollection>)Parameters["Results"]; }
    }
    
    public ILookupParameter<DoubleMatrix> BestKnownFrontParameter {
        get { return (ILookupParameter<DoubleMatrix>)Parameters["BestKnownFront"]; }
    }
    
    //parameters from HypervolumeAnalyzer
    public ILookupParameter<DoubleArray> ReferencePointParameter {
        get { return (ILookupParameter<DoubleArray>)Parameters["ReferencePoint"]; }
    }

    public IResultParameter<DoubleValue> HypervolumeResultParameter {
        get { return (IResultParameter<DoubleValue>)Parameters["Hypervolume"]; }
    }

    public IResultParameter<DoubleValue> BestKnownHypervolumeResultParameter {
        get { return (IResultParameter<DoubleValue>)Parameters["Best known hypervolume"]; }
    }

    public IResultParameter<DoubleValue> HypervolumeDistanceResultParameter {
        get { return (IResultParameter<DoubleValue>)Parameters["Absolute Distance to BestKnownHypervolume"]; }
    }
    
    
    [StorableConstructor]
    protected CustomHVAnalyzer(bool deserializing) : base(deserializing) { }
    protected CustomHVAnalyzer(CustomHVAnalyzer original, Cloner cloner) : base(original, cloner){ }

    
    public override IDeepCloneable Clone(Cloner cloner)
    {
        return new CustomHVAnalyzer(this, cloner);
    }
    
    

    public CustomHVAnalyzer()
    {
        Parameters.Add(new LookupParameter<BoolArray>("Maximization", "maximization or min. of objectives"));

        //add parameters from MOTFAnalyzer
        Parameters.Add(new ScopeTreeLookupParameter<DoubleArray>("Qualities", "The qualities of the parameter vector."));
        Parameters.Add(new LookupParameter<ResultCollection>("Results", "The results collection to write to."));
        Parameters.Add(new LookupParameter<DoubleMatrix>("BestKnownFront", "The currently best known Pareto front"));

        //add parameters from HypervolumeAnalyzer
        Parameters.Add(new LookupParameter<DoubleArray>("ReferencePoint", "The reference point for hypervolume calculation"));
        Parameters.Add(new ResultParameter<DoubleValue>("Hypervolume", "The hypervolume of the current generation"));
        Parameters.Add(new ResultParameter<DoubleValue>("Best known hypervolume", "The optimal hypervolume"));
        Parameters.Add(new ResultParameter<DoubleValue>("Absolute Distance to BestKnownHypervolume", "The difference between the best known and the current hypervolume"));
        
        //set parameters from MOTFAnalyzer - NONE
        
        //set parameters from HypervolumeAnalyzer
        HypervolumeResultParameter.DefaultValue = new DoubleValue(0);
        BestKnownHypervolumeResultParameter.DefaultValue = new DoubleValue(0);
        HypervolumeDistanceResultParameter.DefaultValue = new DoubleValue(0);      
        //ReferencePointParameter.ActualValue = new DoubleArray(new double[] { 120000, 8 });

        }

        public override IOperation Apply()
        {
            var qualities = QualitiesParameter.ActualValue;
            int objectives = qualities[0].Length;
            bool[] maximization = new bool[objectives];
            maximization = MaximizationParameter.ActualValue.ToArray();

            var referencePoint = ReferencePointParameter.ActualValue;

            double best = BestKnownHypervolumeResultParameter.ActualValue.Value;
            /*
            if (referencePoint.SequenceEqual(ReferencePointParameter.ActualValue))
            {
                best = Math.Max(best, !!!Optimal Hypervolume!!!)
            }
            */

            IEnumerable<double[]> front = NonDominatedSelect.SelectNonDominatedVectors(qualities.Select(q => q.ToArray()), maximization, true);

            double hv = Hypervolume.Calculate(front, referencePoint.ToArray(), maximization);

            if (hv > best)
            {
                best = hv;
            }

            HypervolumeResultParameter.ActualValue.Value = hv;
            BestKnownHypervolumeResultParameter.ActualValue.Value = best;
            HypervolumeDistanceResultParameter.ActualValue.Value = best - hv;
            
            return base.Apply();
        }
  }
}