source: branches/2866_SymRegHyperbolicFunctions/HeuristicLab.Problems.DataAnalysis.Symbolic/3.4/Symbols/FactorVariable.cs @ 16655

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2019 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.SymbolicExpressionTreeEncoding;
using HEAL.Attic;
namespace HeuristicLab.Problems.DataAnalysis.Symbolic {
  [StorableType("511B0319-0180-4C2E-81AD-3A8936BE4DE8")]
  [Item("FactorVariable", "Represents a categorical variable (comparable to factors as in R).")]
  public sealed class FactorVariable : VariableBase {
    private readonly Dictionary<string, Dictionary<string, int>> variableValues; // for each variable value also store a zero-based index
    [Storable]
    public IEnumerable<KeyValuePair<string, Dictionary<string, int>>> VariableValues {
      get { return variableValues; }
      set {
        if(value == null) throw new ArgumentNullException();
        variableValues.Clear();
        foreach(var kvp in value) {
          variableValues.Add(kvp.Key, new Dictionary<string, int>(kvp.Value));
        }
      }
    }

    [StorableConstructor]
    private FactorVariable(StorableConstructorFlag _) : base(_) {
      variableValues = new Dictionary<string, Dictionary<string, int>>();
    }
    private FactorVariable(FactorVariable original, Cloner cloner)
      : base(original, cloner) {
      variableValues =
        original.variableValues.ToDictionary(kvp => kvp.Key, kvp => new Dictionary<string, int>(kvp.Value));
    }
    public FactorVariable() : this("FactorVariable", "Represents a categorical variable (comparable to factors as in R).") { }
    public FactorVariable(string name, string description)
      : base(name, description) {
      variableValues = new Dictionary<string, Dictionary<string,int>>();
    }

    public override ISymbolicExpressionTreeNode CreateTreeNode() {
      return new FactorVariableTreeNode(this);
    }

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

    public IEnumerable<string> GetVariableValues(string variableName) {
      return variableValues[variableName].Keys;
    }

    public int GetIndexForValue(string variableName, string variableValue) {
      return variableValues[variableName][variableValue];
    }
  }
}