Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/genetics/ListPopulation.html @ 32:d7a43156a79b default tip
new tabs
author | dwinter |
---|---|
date | Mon, 10 Oct 2011 17:52:22 +0200 |
parents | cbf34dd4d7e6 |
children |
line wrap: on
line source
<HTML> <BODY BGCOLOR="white"> <PRE> <FONT color="green">001</FONT> /*<a name="line.1"></a> <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a> <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a> <FONT color="green">008</FONT> *<a name="line.8"></a> <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> <FONT color="green">010</FONT> *<a name="line.10"></a> <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> <FONT color="green">014</FONT> * See the License for the specific language governing permissions and<a name="line.14"></a> <FONT color="green">015</FONT> * limitations under the License.<a name="line.15"></a> <FONT color="green">016</FONT> */<a name="line.16"></a> <FONT color="green">017</FONT> package org.apache.commons.math.genetics;<a name="line.17"></a> <FONT color="green">018</FONT> <a name="line.18"></a> <FONT color="green">019</FONT> import java.util.ArrayList;<a name="line.19"></a> <FONT color="green">020</FONT> import java.util.Iterator;<a name="line.20"></a> <FONT color="green">021</FONT> import java.util.List;<a name="line.21"></a> <FONT color="green">022</FONT> <a name="line.22"></a> <FONT color="green">023</FONT> /**<a name="line.23"></a> <FONT color="green">024</FONT> * Population of chromosomes represented by a {@link List}.<a name="line.24"></a> <FONT color="green">025</FONT> *<a name="line.25"></a> <FONT color="green">026</FONT> * @since 2.0<a name="line.26"></a> <FONT color="green">027</FONT> * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $<a name="line.27"></a> <FONT color="green">028</FONT> */<a name="line.28"></a> <FONT color="green">029</FONT> public abstract class ListPopulation implements Population {<a name="line.29"></a> <FONT color="green">030</FONT> <a name="line.30"></a> <FONT color="green">031</FONT> /** List of chromosomes */<a name="line.31"></a> <FONT color="green">032</FONT> private List<Chromosome> chromosomes;<a name="line.32"></a> <FONT color="green">033</FONT> <a name="line.33"></a> <FONT color="green">034</FONT> /** maximial size of the population */<a name="line.34"></a> <FONT color="green">035</FONT> private int populationLimit;<a name="line.35"></a> <FONT color="green">036</FONT> <a name="line.36"></a> <FONT color="green">037</FONT> <a name="line.37"></a> <FONT color="green">038</FONT> /**<a name="line.38"></a> <FONT color="green">039</FONT> * Creates a new ListPopulation instance.<a name="line.39"></a> <FONT color="green">040</FONT> *<a name="line.40"></a> <FONT color="green">041</FONT> * @param chromosomes list of chromosomes in the population<a name="line.41"></a> <FONT color="green">042</FONT> * @param populationLimit maximal size of the population<a name="line.42"></a> <FONT color="green">043</FONT> */<a name="line.43"></a> <FONT color="green">044</FONT> public ListPopulation (List<Chromosome> chromosomes, int populationLimit) {<a name="line.44"></a> <FONT color="green">045</FONT> if (chromosomes.size() > populationLimit) {<a name="line.45"></a> <FONT color="green">046</FONT> throw new IllegalArgumentException("List of chromosomes bigger than maxPopulationSize.");<a name="line.46"></a> <FONT color="green">047</FONT> }<a name="line.47"></a> <FONT color="green">048</FONT> if (populationLimit < 0) {<a name="line.48"></a> <FONT color="green">049</FONT> throw new IllegalArgumentException("Population limit has to be >= 0");<a name="line.49"></a> <FONT color="green">050</FONT> }<a name="line.50"></a> <FONT color="green">051</FONT> <a name="line.51"></a> <FONT color="green">052</FONT> this.chromosomes = chromosomes;<a name="line.52"></a> <FONT color="green">053</FONT> this.populationLimit = populationLimit;<a name="line.53"></a> <FONT color="green">054</FONT> }<a name="line.54"></a> <FONT color="green">055</FONT> <a name="line.55"></a> <FONT color="green">056</FONT> /**<a name="line.56"></a> <FONT color="green">057</FONT> * Creates a new ListPopulation instance and initializes its inner<a name="line.57"></a> <FONT color="green">058</FONT> * chromosome list.<a name="line.58"></a> <FONT color="green">059</FONT> *<a name="line.59"></a> <FONT color="green">060</FONT> * @param populationLimit maximal size of the population<a name="line.60"></a> <FONT color="green">061</FONT> */<a name="line.61"></a> <FONT color="green">062</FONT> public ListPopulation (int populationLimit) {<a name="line.62"></a> <FONT color="green">063</FONT> if (populationLimit < 0) {<a name="line.63"></a> <FONT color="green">064</FONT> throw new IllegalArgumentException("Population limit has to be >= 0");<a name="line.64"></a> <FONT color="green">065</FONT> }<a name="line.65"></a> <FONT color="green">066</FONT> this.populationLimit = populationLimit;<a name="line.66"></a> <FONT color="green">067</FONT> this.chromosomes = new ArrayList<Chromosome>(populationLimit);<a name="line.67"></a> <FONT color="green">068</FONT> }<a name="line.68"></a> <FONT color="green">069</FONT> <a name="line.69"></a> <FONT color="green">070</FONT> /**<a name="line.70"></a> <FONT color="green">071</FONT> * Sets the list of chromosomes.<a name="line.71"></a> <FONT color="green">072</FONT> * @param chromosomes the list of chromosomes<a name="line.72"></a> <FONT color="green">073</FONT> */<a name="line.73"></a> <FONT color="green">074</FONT> public void setChromosomes(List<Chromosome> chromosomes) {<a name="line.74"></a> <FONT color="green">075</FONT> this.chromosomes = chromosomes;<a name="line.75"></a> <FONT color="green">076</FONT> }<a name="line.76"></a> <FONT color="green">077</FONT> <a name="line.77"></a> <FONT color="green">078</FONT> /**<a name="line.78"></a> <FONT color="green">079</FONT> * Access the list of chromosomes.<a name="line.79"></a> <FONT color="green">080</FONT> * @return the list of chromosomes<a name="line.80"></a> <FONT color="green">081</FONT> */<a name="line.81"></a> <FONT color="green">082</FONT> public List<Chromosome> getChromosomes() {<a name="line.82"></a> <FONT color="green">083</FONT> return chromosomes;<a name="line.83"></a> <FONT color="green">084</FONT> }<a name="line.84"></a> <FONT color="green">085</FONT> <a name="line.85"></a> <FONT color="green">086</FONT> /**<a name="line.86"></a> <FONT color="green">087</FONT> * Add the given chromosome to the population.<a name="line.87"></a> <FONT color="green">088</FONT> * @param chromosome the chromosome to add.<a name="line.88"></a> <FONT color="green">089</FONT> */<a name="line.89"></a> <FONT color="green">090</FONT> public void addChromosome(Chromosome chromosome) {<a name="line.90"></a> <FONT color="green">091</FONT> this.chromosomes.add(chromosome);<a name="line.91"></a> <FONT color="green">092</FONT> }<a name="line.92"></a> <FONT color="green">093</FONT> <a name="line.93"></a> <FONT color="green">094</FONT> /**<a name="line.94"></a> <FONT color="green">095</FONT> * Access the fittest chromosome in this population.<a name="line.95"></a> <FONT color="green">096</FONT> * @return the fittest chromosome.<a name="line.96"></a> <FONT color="green">097</FONT> */<a name="line.97"></a> <FONT color="green">098</FONT> public Chromosome getFittestChromosome() {<a name="line.98"></a> <FONT color="green">099</FONT> // best so far<a name="line.99"></a> <FONT color="green">100</FONT> Chromosome bestChromosome = this.chromosomes.get(0);<a name="line.100"></a> <FONT color="green">101</FONT> for (Chromosome chromosome : this.chromosomes) {<a name="line.101"></a> <FONT color="green">102</FONT> if (chromosome.compareTo(bestChromosome) > 0) {<a name="line.102"></a> <FONT color="green">103</FONT> // better chromosome found<a name="line.103"></a> <FONT color="green">104</FONT> bestChromosome = chromosome;<a name="line.104"></a> <FONT color="green">105</FONT> }<a name="line.105"></a> <FONT color="green">106</FONT> }<a name="line.106"></a> <FONT color="green">107</FONT> return bestChromosome;<a name="line.107"></a> <FONT color="green">108</FONT> }<a name="line.108"></a> <FONT color="green">109</FONT> <a name="line.109"></a> <FONT color="green">110</FONT> /**<a name="line.110"></a> <FONT color="green">111</FONT> * Access the maximum population size.<a name="line.111"></a> <FONT color="green">112</FONT> * @return the maximum population size.<a name="line.112"></a> <FONT color="green">113</FONT> */<a name="line.113"></a> <FONT color="green">114</FONT> public int getPopulationLimit() {<a name="line.114"></a> <FONT color="green">115</FONT> return this.populationLimit;<a name="line.115"></a> <FONT color="green">116</FONT> }<a name="line.116"></a> <FONT color="green">117</FONT> <a name="line.117"></a> <FONT color="green">118</FONT> /**<a name="line.118"></a> <FONT color="green">119</FONT> * Sets the maximal population size.<a name="line.119"></a> <FONT color="green">120</FONT> * @param populationLimit maximal population size.<a name="line.120"></a> <FONT color="green">121</FONT> */<a name="line.121"></a> <FONT color="green">122</FONT> public void setPopulationLimit(int populationLimit) {<a name="line.122"></a> <FONT color="green">123</FONT> this.populationLimit = populationLimit;<a name="line.123"></a> <FONT color="green">124</FONT> }<a name="line.124"></a> <FONT color="green">125</FONT> <a name="line.125"></a> <FONT color="green">126</FONT> /**<a name="line.126"></a> <FONT color="green">127</FONT> * Access the current population size.<a name="line.127"></a> <FONT color="green">128</FONT> * @return the current population size.<a name="line.128"></a> <FONT color="green">129</FONT> */<a name="line.129"></a> <FONT color="green">130</FONT> public int getPopulationSize() {<a name="line.130"></a> <FONT color="green">131</FONT> return this.chromosomes.size();<a name="line.131"></a> <FONT color="green">132</FONT> }<a name="line.132"></a> <FONT color="green">133</FONT> <a name="line.133"></a> <FONT color="green">134</FONT> /**<a name="line.134"></a> <FONT color="green">135</FONT> * {@inheritDoc}<a name="line.135"></a> <FONT color="green">136</FONT> */<a name="line.136"></a> <FONT color="green">137</FONT> @Override<a name="line.137"></a> <FONT color="green">138</FONT> public String toString() {<a name="line.138"></a> <FONT color="green">139</FONT> return this.chromosomes.toString();<a name="line.139"></a> <FONT color="green">140</FONT> }<a name="line.140"></a> <FONT color="green">141</FONT> <a name="line.141"></a> <FONT color="green">142</FONT> /**<a name="line.142"></a> <FONT color="green">143</FONT> * Chromosome list iterator<a name="line.143"></a> <FONT color="green">144</FONT> *<a name="line.144"></a> <FONT color="green">145</FONT> * @return chromosome iterator<a name="line.145"></a> <FONT color="green">146</FONT> */<a name="line.146"></a> <FONT color="green">147</FONT> public Iterator<Chromosome> iterator() {<a name="line.147"></a> <FONT color="green">148</FONT> return chromosomes.iterator();<a name="line.148"></a> <FONT color="green">149</FONT> }<a name="line.149"></a> <FONT color="green">150</FONT> }<a name="line.150"></a> </PRE> </BODY> </HTML>