Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Permutation/Permutation.cs @ 1027

Last change on this file since 1027 was 850, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Permutation namespace (#331)

File size: 2.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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.Text;
25using System.Xml;
26using HeuristicLab.Data;
27
28namespace HeuristicLab.Permutation {
29  /// <summary>
30  /// The base class for a permutation, which is an ordered combination.
31  /// </summary>
32  public class Permutation : IntArrayData {
33    /// <summary>
34    /// Initializes a new instance of <see cref="Permutation"/>.
35    /// </summary>
36    public Permutation()
37      : base() {
38    }
39    /// <summary>
40    /// Initializes a new instance of <see cref="Permutation"/> with the given
41    /// <paramref name="permutation"/> array.
42    /// </summary>
43    /// <param name="permutation">The permutation array to assign.</param>
44    public Permutation(int[] permutation)
45      : base(permutation) {
46    }
47
48    /// <summary>
49    /// Clones the current instance.
50    /// </summary>
51    /// <param name="clonedObjects">A dictionary of all already cloned objects. (Needed to
52    /// avoid cycles.)</param>
53    /// <returns>The cloned object as <see cref="Permutation"/>.</returns>
54    public override object Clone(IDictionary<Guid, object> clonedObjects) {
55      Permutation clone = new Permutation((int[])Data.Clone());
56      clonedObjects.Add(Guid, clone);
57      return clone;
58    }
59  }
60}
Note: See TracBrowser for help on using the repository browser.