source: trunk/sources/HeuristicLab.Problems.DataAnalysis/3.4/Implementation/Transformations/LinearTransformation.cs @ 11114

Last change on this file since 11114 was 11114, checked in by mkommend, 5 years ago

#2206: Merged data preprocessing into the trunk.

File size: 3.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2013 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22
23using System;
24using System.Collections.Generic;
25using System.Linq;
26using HeuristicLab.Common;
27using HeuristicLab.Core;
28using HeuristicLab.Data;
29using HeuristicLab.Parameters;
30using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
31
32namespace HeuristicLab.Problems.DataAnalysis {
33  [Item("Linear Transformation", "f(x) = k * x + d | Represents a linear transformation with multiplication and addition.")]
34  public class LinearTransformation : Transformation<double> {
35    protected const string MultiplierParameterName = "Multiplier";
36    protected const string AddendParameterName = "Addend";
37
38    #region Parameters
39    public IValueParameter<DoubleValue> MultiplierParameter {
40      get { return (IValueParameter<DoubleValue>)Parameters[MultiplierParameterName]; }
41    }
42    public IValueParameter<DoubleValue> AddendParameter {
43      get { return (IValueParameter<DoubleValue>)Parameters[AddendParameterName]; }
44    }
45    #endregion
46
47    #region properties
48    public override string ShortName {
49      get { return "Lin"; }
50    }
51    public double Multiplier {
52      get { return MultiplierParameter.Value.Value; }
53      protected set {
54        MultiplierParameter.Value.Value = value;
55      }
56    }
57
58    public double Addend {
59      get { return AddendParameter.Value.Value; }
60      protected set {
61        AddendParameter.Value.Value = value;
62      }
63    }
64    #endregion
65
66    [StorableConstructor]
67    protected LinearTransformation(bool deserializing) : base(deserializing) { }
68    protected LinearTransformation(LinearTransformation original, Cloner cloner)
69      : base(original, cloner) {
70    }
71    public LinearTransformation(IEnumerable<string> allowedColumns)
72      : base(allowedColumns) {
73      Parameters.Add(new ValueParameter<DoubleValue>(MultiplierParameterName, "k | Multiplier for linear transformation", new DoubleValue(1.0)));
74      Parameters.Add(new ValueParameter<DoubleValue>(AddendParameterName, "d | Addend for linear transformation", new DoubleValue(0.0)));
75    }
76
77    public override IDeepCloneable Clone(Cloner cloner) {
78      return new LinearTransformation(this, cloner);
79    }
80
81    public override IEnumerable<double> Apply(IEnumerable<double> data) {
82      return data.Select(e => e * Multiplier + Addend);
83    }
84
85    public override bool Check(IEnumerable<double> data, out string errorMsg) {
86      errorMsg = null;
87      if (Multiplier == 0.0) {
88        errorMsg = String.Format("Multiplicand is 0, all {0} entries will be set to {1}. Inverse apply will not be possible (division by 0).", data.Count(), Addend);
89        return false;
90      }
91      return true;
92    }
93  }
94}
Note: See TracBrowser for help on using the repository browser.