source: branches/ProgrammableProblem/HeuristicLab.Problems.Programmable/3.3/Encodings/Individual.cs @ 11598

#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.Encodings.BinaryVectorEncoding;
using HeuristicLab.Encodings.IntegerVectorEncoding;
using HeuristicLab.Encodings.PermutationEncoding;
using HeuristicLab.Encodings.RealVectorEncoding;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Problems.Programmable {
  [StorableClass]
  public class Individual : Item {
    [Storable]
    public IEncoding Encoding { get; private set; }
    [Storable]
    protected IScope Scope { get; private set; }

    public Individual(IEncoding encoding, IScope scope) {
      Encoding = encoding;
      Scope = scope;
    }

    [StorableConstructor]
    protected Individual(bool deserializing) : base(deserializing) { }

    public override IDeepCloneable Clone(Cloner cloner) { return new Individual(this, cloner); }
    protected Individual(Individual original, Cloner cloner)
      : base(original, cloner) {
      Encoding = cloner.Clone(original.Encoding);
      Scope = cloner.Clone(original.Scope);
    }

    public virtual IItem this[string name] {
      get { return ExtractScopeValue(name, Encoding.Name, Scope); }
      set { SetScopeValue(name, Encoding.Name, Scope, value); }
    }

    internal virtual Individual Copy(IScope scope) {
      var individual = Encoding.CreateIndividual(scope);
      individual[Encoding.Name] = this[Encoding.Name];
      return individual;
    }

    protected static IItem ExtractScopeValue(string name, string encodingName, IScope scope) {
      if (name != encodingName) throw new ArgumentException(string.Format("{0} is not part of the specified encoding.", name));
      if (!scope.Variables.ContainsKey(name)) throw new ArgumentException(string.Format("Encoding part {0} cannot be found in the provided scope.", name));
      var value = scope.Variables[name].Value;
      if (value == null) throw new ArgumentException(string.Format("Encoding part {0} is null.", name));
      return value;
    }

    protected static void SetScopeValue(string name, string encodingName, IScope scope, IItem value) {
      if (name != encodingName) throw new ArgumentException(string.Format("{0} is not part of the specified encoding.", name));
      if (value == null) throw new ArgumentNullException("value");

      if (!scope.Variables.ContainsKey(name)) scope.Variables.Add(new Variable(name, value));
      else scope.Variables[name].Value = value;
      var variable = scope.Variables[name];
    }
  }

  #region extension methods
  public static class IndividualExtensionMethods {
    public static BinaryVector BinaryVector(this Individual individual, string name) {
      return (BinaryVector)individual[name];
    }
    public static IntegerVector IntegerVector(this Individual individual, string name) {
      return (IntegerVector)individual[name];
    }
    public static Permutation Permutation(this Individual individual, string name) {
      return (Permutation)individual[name];
    }
    public static RealVector RealVector(this Individual individual, string name) {
      return (RealVector)individual[name];
    }
  }
  #endregion
}