source: branches/HeuristicLab.EvolutionTracking/HeuristicLab.EvolutionTracking/3.4/GenealogyGraph/GenealogyGraphNode.cs @ 11253

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 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.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.EvolutionTracking {
  [StorableClass]
  [Item("GenealogGraphNode", "A class representing a node in the GenealogyGraph")]
  public class GenealogyGraphNode : Vertex, IGenealogyGraphNode {
    [StorableConstructor]
    protected GenealogyGraphNode(bool deserializing) : base(deserializing) { }

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

    // this constructor emulates the behavior of a copy constructor
    // it returns a shallow copy in which the arcs are not cloned
    protected GenealogyGraphNode(IGenealogyGraphNode original)
      : base((IDeepCloneable)original.Data.Clone()) {
      Quality = original.Quality;
      Rank = original.Rank;
      IsElite = original.IsElite;
      Id = Guid.NewGuid().ToString();
    }

    protected GenealogyGraphNode(GenealogyGraphNode original, Cloner cloner)
      : base(original, cloner) {
      Quality = original.Quality;
      Rank = original.Rank;
      IsElite = original.IsElite;
      Id = Guid.NewGuid().ToString();
    }

    public GenealogyGraphNode(IDeepCloneable data)
      : base(data) {
      Id = Guid.NewGuid().ToString();
    }

    public new IEnumerable<IGenealogyGraphArc> InArcs {
      get { return base.InArcs.Cast<IGenealogyGraphArc>(); }
    }

    public new IEnumerable<IGenealogyGraphArc> OutArcs {
      get { return base.OutArcs.Cast<IGenealogyGraphArc>(); }
    }

    public IEnumerable<IGenealogyGraphNode> Ancestors {
      get {
        // for performance, we use a hashset for lookup and a list for iteration
        var nodes = new HashSet<IGenealogyGraphNode> { this };
        var list = new List<IGenealogyGraphNode> { this };
        int i = 0;
        while (i != list.Count) {
          foreach (var e in list[i].InArcs) {
            if (nodes.Contains(e.Source)) continue;
            nodes.Add(e.Source);
            list.Add(e.Source);
          }
          ++i;
        }
        return list;
      }
    }
    /// <summary>
    /// Performs a downward-breath-traversal of the genealogy graph using the nodes OutArcs
    /// </summary>
    /// <returns>All the descendants of the current node</returns>
    public IEnumerable<IGenealogyGraphNode> Descendants {
      get {
        var nodes = new HashSet<IGenealogyGraphNode> { this };
        var list = new List<IGenealogyGraphNode> { this };
        int i = 0;
        while (i != list.Count) {
          foreach (var e in list[i].OutArcs) {
            if (nodes.Contains(e.Target)) continue;
            nodes.Add(e.Target);
            list.Add(e.Target);
          }
          ++i;
        }
        return list;
      }
    }
    [Storable]
    public string Id { get; private set; }

    [Storable]
    private double rank;
    public double Rank {
      get { return rank; }
      set { rank = value; }
    }
    [Storable]
    private double quality;
    public double Quality {
      get { return quality; }
      set { quality = value; }
    }
    [Storable]
    private bool isElite;
    public bool IsElite {
      get { return isElite; }
      set { isElite = value; }
    }
    public int CompareTo(IGenealogyGraphNode other) {
      return Quality.CompareTo(other.Quality);
    }
    public IEnumerable<IGenealogyGraphNode> Parents {
      get { return InArcs.Select(a => a.Source); }
    }
    public IEnumerable<IGenealogyGraphNode> Children {
      get { return OutArcs.Select(a => a.Target); }
    }
  }

  [StorableClass]
  [Item("GenealogyGraphNode", "A genealogy graph node which also has a Content")]
  public class GenealogyGraphNode<T> : GenealogyGraphNode, IGenealogyGraphNode<T> where T : class, IItem {
    public new T Data {
      get { return (T)base.Data; }
      set { base.Data = value; }
    }

    public GenealogyGraphNode(IGenealogyGraphNode<T> original) : base(original) { }

    public GenealogyGraphNode(IDeepCloneable content) : base(content) { }

    protected GenealogyGraphNode(GenealogyGraphNode<T> original, Cloner cloner)
      : base(original, cloner) {
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new GenealogyGraphNode<T>(this, cloner);
    }
    public new IEnumerable<IGenealogyGraphNode<T>> Parents {
      get { return base.Parents.Cast<IGenealogyGraphNode<T>>(); }
    }
    public new IEnumerable<IGenealogyGraphNode<T>> Children {
      get { return base.Children.Cast<IGenealogyGraphNode<T>>(); }
    }
    public new IEnumerable<IGenealogyGraphNode<T>> Ancestors {
      get { return base.Ancestors.Cast<IGenealogyGraphNode<T>>(); }
    }
    public new IEnumerable<IGenealogyGraphNode<T>> Descendants {
      get { return base.Descendants.Cast<IGenealogyGraphNode<T>>(); }
    }
  }
}