source: trunk/sources/HeuristicLab.Optimizer/3.3/StartPage.cs @ 15223

Last change on this file since 15223 was 15223, checked in by abeham, 2 years ago

#2797: Updated sample to change from Schwefel to Rastrigin (in the hope that it's numerically more stable)

File size: 9.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 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
22using System;
23using System.Collections.Generic;
24using System.IO;
25using System.Linq;
26using System.Reflection;
27using System.Threading;
28using System.Windows.Forms;
29using HeuristicLab.Common;
30using HeuristicLab.Core;
31using HeuristicLab.MainForm;
32using HeuristicLab.Persistence.Default.Xml;
33
34namespace HeuristicLab.Optimizer {
35  [View("Start Page")]
36  public partial class StartPage : HeuristicLab.MainForm.WindowsForms.View {
37    private const string StandardProblemsGroupName = "Standard Problems";
38    private const string DataAnalysisGroupName = "Data Analysis";
39    private const string ScriptsGroupName = "Scripts";
40    private const string UncategorizedGroupName = "Uncategorized";
41    private const string SampleNamePrefix = "HeuristicLab.Optimizer.Documents.";
42    private const string SampleNameSuffix = ".hl";
43
44    private readonly Dictionary<ListViewGroup, List<string>> groupLookup = new Dictionary<ListViewGroup, List<string>>();
45    private readonly ListViewGroup standardProblemsGroup = new ListViewGroup(StandardProblemsGroupName);
46    private readonly ListViewGroup dataAnalysisGroup = new ListViewGroup(DataAnalysisGroupName);
47    private readonly ListViewGroup scriptsGroup = new ListViewGroup(ScriptsGroupName);
48    private readonly ListViewGroup uncategorizedGroup = new ListViewGroup(UncategorizedGroupName);
49
50    private IProgress progress;
51
52    public StartPage() {
53      InitializeComponent();
54    }
55
56    protected override void OnInitialized(EventArgs e) {
57      base.OnInitialized(e);
58      Assembly assembly = Assembly.GetExecutingAssembly();
59      AssemblyFileVersionAttribute version = assembly.GetCustomAttributes(typeof(AssemblyFileVersionAttribute), true).
60                                             Cast<AssemblyFileVersionAttribute>().FirstOrDefault();
61      titleLabel.Text = "HeuristicLab Optimizer";
62      if (version != null) titleLabel.Text += " " + version.Version;
63
64      try {
65        using (Stream stream = assembly.GetManifestResourceStream(typeof(StartPage), "Documents.FirstSteps.rtf"))
66          firstStepsRichTextBox.LoadFile(stream, RichTextBoxStreamType.RichText);
67      } catch (Exception) { }
68
69      samplesListView.Enabled = false;
70      samplesListView.Groups.Add(standardProblemsGroup);
71      samplesListView.Groups.Add(dataAnalysisGroup);
72      samplesListView.Groups.Add(scriptsGroup);
73      samplesListView.Groups.Add(uncategorizedGroup);
74      FillGroupLookup();
75
76      showStartPageCheckBox.Checked = Properties.Settings.Default.ShowStartPage;
77
78      ThreadPool.QueueUserWorkItem(new WaitCallback(LoadSamples));
79    }
80
81    protected override void OnClosing(FormClosingEventArgs e) {
82      base.OnClosing(e);
83      if (e.CloseReason == CloseReason.UserClosing) {
84        e.Cancel = true;
85        this.Hide();
86      }
87    }
88
89    private void LoadSamples(object state) {
90      progress = MainFormManager.GetMainForm<HeuristicLab.MainForm.WindowsForms.MainForm>().AddOperationProgressToView(samplesListView, "Loading...");
91      try {
92        var assembly = Assembly.GetExecutingAssembly();
93        var samples = assembly.GetManifestResourceNames().Where(x => x.EndsWith(SampleNameSuffix));
94        int count = samples.Count();
95
96        foreach (var entry in groupLookup) {
97          var group = entry.Key;
98          var sampleList = entry.Value;
99          foreach (var sampleName in sampleList) {
100            string resourceName = SampleNamePrefix + sampleName + SampleNameSuffix;
101            LoadSample(resourceName, assembly, group, count);
102          }
103        }
104
105        var categorizedSamples = groupLookup.Select(x => x.Value).SelectMany(x => x).Select(x => SampleNamePrefix + x + SampleNameSuffix);
106        var uncategorizedSamples = samples.Except(categorizedSamples);
107
108        foreach (var resourceName in uncategorizedSamples) {
109          LoadSample(resourceName, assembly, uncategorizedGroup, count);
110        }
111
112        OnAllSamplesLoaded();
113      } finally {
114        MainFormManager.GetMainForm<HeuristicLab.MainForm.WindowsForms.MainForm>().RemoveOperationProgressFromView(samplesListView);
115      }
116    }
117
118    private void LoadSample(string name, Assembly assembly, ListViewGroup group, int count) {
119      string path = Path.GetTempFileName();
120      try {
121        using (var stream = assembly.GetManifestResourceStream(name)) {
122          WriteStreamToTempFile(stream, path); // create a file in a temporary folder (persistence cannot load these files directly from the stream)
123          var item = XmlParser.Deserialize<INamedItem>(path);
124          OnSampleLoaded(item, group, 1.0 / count);
125        }
126      } catch (Exception) {
127      } finally {
128        if (File.Exists(path)) {
129          File.Delete(path); // make sure we remove the temporary file
130        }
131      }
132    }
133
134    private void FillGroupLookup() {
135      var standardProblems = new List<string> { "ALPSGA_TSP", "ES_Griewank", "OSES_Griewank", "GA_Grouping", "GA_TSP", "GA_VRP", "GE_ArtificialAnt",
136                "IslandGA_TSP", "LS_Knapsack", "PSO_Rastrigin", "RAPGA_JSSP",
137                "SA_Rastrigin", "SGP_SantaFe", "GP_Multiplexer", "SGP_Robocode", "SS_VRP", "TS_TSP", "TS_VRP", "VNS_OP", "VNS_TSP", "GA_BPP"
138        };
139      groupLookup[standardProblemsGroup] = standardProblems;
140      var dataAnalysisProblems = new List<string> { "ALPSGP_SymReg", "SGP_SymbClass", "SGP_SymbReg", "OSGP_TimeSeries", "GE_SymbReg", "GPR" };
141      groupLookup[dataAnalysisGroup] = dataAnalysisProblems;
142      var scripts = new List<string> { "GA_QAP_Script", "GUI_Automation_Script", "OSGA_Rastrigin_Script",
143                                       "GridSearch_RF_Classification_Script", "GridSearch_RF_Regression_Script",
144                                       "GridSearch_SVM_Classification_Script", "GridSearch_SVM_Regression_Script" };
145      groupLookup[scriptsGroup] = scripts;
146    }
147
148    private void OnSampleLoaded(INamedItem sample, ListViewGroup group, double progress) {
149      if (InvokeRequired)
150        Invoke(new Action<INamedItem, ListViewGroup, double>(OnSampleLoaded), sample, group, progress);
151      else {
152        ListViewItem item = new ListViewItem(new string[] { sample.Name, sample.Description }, group);
153        item.ToolTipText = sample.ItemName + ": " + sample.ItemDescription;
154        samplesListView.SmallImageList.Images.Add(sample.ItemImage);
155        item.ImageIndex = samplesListView.SmallImageList.Images.Count - 1;
156        item.Tag = sample;
157        samplesListView.Items.Add(item);
158        this.progress.ProgressValue += progress;
159      }
160    }
161    private void OnAllSamplesLoaded() {
162      if (InvokeRequired)
163        Invoke(new Action(OnAllSamplesLoaded));
164      else {
165        samplesListView.Enabled = samplesListView.Items.Count > 0;
166        if (samplesListView.Items.Count > 0) {
167          for (int i = 0; i < samplesListView.Columns.Count; i++)
168            samplesListView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
169        }
170      }
171    }
172
173    private void firstStepsRichTextBox_LinkClicked(object sender, LinkClickedEventArgs e) {
174      System.Diagnostics.Process.Start(e.LinkText);
175    }
176
177    private void samplesListView_DoubleClick(object sender, EventArgs e) {
178      if (samplesListView.SelectedItems.Count == 1) {
179        var mainForm = MainFormManager.GetMainForm<MainForm.WindowsForms.MainForm>();
180        try {
181          mainForm.SetWaitCursor();
182          mainForm.ShowContent((IContent)((IItem)samplesListView.SelectedItems[0].Tag).Clone());
183        } finally {
184          mainForm.ResetWaitCursor();
185        }
186
187      }
188    }
189    private void samplesListView_ItemDrag(object sender, ItemDragEventArgs e) {
190      ListViewItem listViewItem = (ListViewItem)e.Item;
191      IItem item = (IItem)listViewItem.Tag;
192      DataObject data = new DataObject();
193      data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, item);
194      DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy);
195    }
196
197    private void showStartPageCheckBox_CheckedChanged(object sender, EventArgs e) {
198      Properties.Settings.Default.ShowStartPage = showStartPageCheckBox.Checked;
199      Properties.Settings.Default.Save();
200    }
201
202    #region Helpers
203    private void WriteStreamToTempFile(Stream stream, string path) {
204      using (FileStream output = new FileStream(path, FileMode.Create, FileAccess.Write)) {
205        stream.CopyTo(output);
206      }
207    }
208    #endregion
209  }
210}
Note: See TracBrowser for help on using the repository browser.