The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.maltparser.parser.history.kbest;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.ArrayList;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    import org.maltparser.core.exception.MaltChainedException;<a name="line.5"></a>
<FONT color="green">006</FONT>    import org.maltparser.parser.history.action.SingleDecision;<a name="line.6"></a>
<FONT color="green">007</FONT>    /**<a name="line.7"></a>
<FONT color="green">008</FONT>    *<a name="line.8"></a>
<FONT color="green">009</FONT>    * @author Johan Hall<a name="line.9"></a>
<FONT color="green">010</FONT>    * @since 1.1<a name="line.10"></a>
<FONT color="green">011</FONT>    **/<a name="line.11"></a>
<FONT color="green">012</FONT>    public class KBestList {<a name="line.12"></a>
<FONT color="green">013</FONT>            protected ArrayList&lt;Candidate&gt; kBestList;<a name="line.13"></a>
<FONT color="green">014</FONT>            protected int k = -1;<a name="line.14"></a>
<FONT color="green">015</FONT>            protected int topCandidateIndex;<a name="line.15"></a>
<FONT color="green">016</FONT>            protected int addCandidateIndex;<a name="line.16"></a>
<FONT color="green">017</FONT>            protected SingleDecision decision;<a name="line.17"></a>
<FONT color="green">018</FONT>            <a name="line.18"></a>
<FONT color="green">019</FONT>            /**<a name="line.19"></a>
<FONT color="green">020</FONT>             * Creates a unrestricted k-best list<a name="line.20"></a>
<FONT color="green">021</FONT>             * <a name="line.21"></a>
<FONT color="green">022</FONT>             * @param decision a reference to the single decision that uses the k-best list<a name="line.22"></a>
<FONT color="green">023</FONT>             */<a name="line.23"></a>
<FONT color="green">024</FONT>            public KBestList(SingleDecision decision) {<a name="line.24"></a>
<FONT color="green">025</FONT>                    this(-1, decision);<a name="line.25"></a>
<FONT color="green">026</FONT>            }<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>            /**<a name="line.28"></a>
<FONT color="green">029</FONT>             * Creates a k-best list<a name="line.29"></a>
<FONT color="green">030</FONT>             * <a name="line.30"></a>
<FONT color="green">031</FONT>             * @param k     the k-best list size<a name="line.31"></a>
<FONT color="green">032</FONT>             * @param decision      a reference to the single decision that uses the k-best list.<a name="line.32"></a>
<FONT color="green">033</FONT>             */<a name="line.33"></a>
<FONT color="green">034</FONT>            public KBestList(Integer k, SingleDecision decision) {<a name="line.34"></a>
<FONT color="green">035</FONT>                    setK(k.intValue());<a name="line.35"></a>
<FONT color="green">036</FONT>                    setDecision(decision);<a name="line.36"></a>
<FONT color="green">037</FONT>                    if (this.k &gt; 0) {<a name="line.37"></a>
<FONT color="green">038</FONT>                            kBestList = new ArrayList&lt;Candidate&gt;(this.k);<a name="line.38"></a>
<FONT color="green">039</FONT>                            initKBestList();<a name="line.39"></a>
<FONT color="green">040</FONT>                    } else {<a name="line.40"></a>
<FONT color="green">041</FONT>                            kBestList = new ArrayList&lt;Candidate&gt;();<a name="line.41"></a>
<FONT color="green">042</FONT>                    }<a name="line.42"></a>
<FONT color="green">043</FONT>                    <a name="line.43"></a>
<FONT color="green">044</FONT>            }<a name="line.44"></a>
<FONT color="green">045</FONT>            <a name="line.45"></a>
<FONT color="green">046</FONT>            protected void initKBestList() {<a name="line.46"></a>
<FONT color="green">047</FONT>                    for (int i=0; i &lt; this.k; i++) {<a name="line.47"></a>
<FONT color="green">048</FONT>                            kBestList.add(new Candidate());<a name="line.48"></a>
<FONT color="green">049</FONT>                    }<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>            /**<a name="line.52"></a>
<FONT color="green">053</FONT>             * Resets the k-best list<a name="line.53"></a>
<FONT color="green">054</FONT>             */<a name="line.54"></a>
<FONT color="green">055</FONT>            public void reset() {<a name="line.55"></a>
<FONT color="green">056</FONT>                    this.topCandidateIndex = 0;<a name="line.56"></a>
<FONT color="green">057</FONT>                    this.addCandidateIndex = 0;<a name="line.57"></a>
<FONT color="green">058</FONT>            }<a name="line.58"></a>
<FONT color="green">059</FONT>            <a name="line.59"></a>
<FONT color="green">060</FONT>            /**<a name="line.60"></a>
<FONT color="green">061</FONT>             * Adds a candidate to the k-best list<a name="line.61"></a>
<FONT color="green">062</FONT>             * <a name="line.62"></a>
<FONT color="green">063</FONT>             * @param actionCode the integer representation  of candidate action<a name="line.63"></a>
<FONT color="green">064</FONT>             * @throws MaltChainedException<a name="line.64"></a>
<FONT color="green">065</FONT>             */<a name="line.65"></a>
<FONT color="green">066</FONT>            public void add(int actionCode) throws MaltChainedException {<a name="line.66"></a>
<FONT color="green">067</FONT>                    if (k != -1 &amp;&amp; addCandidateIndex &gt;= k) { return; }<a name="line.67"></a>
<FONT color="green">068</FONT>                    if (addCandidateIndex &gt;= kBestList.size()) { kBestList.add(new Candidate()); }<a name="line.68"></a>
<FONT color="green">069</FONT>                    kBestList.get(addCandidateIndex).setActionCode(actionCode);<a name="line.69"></a>
<FONT color="green">070</FONT>                    if (addCandidateIndex == 0) {<a name="line.70"></a>
<FONT color="green">071</FONT>                            if (decision instanceof SingleDecision) {<a name="line.71"></a>
<FONT color="green">072</FONT>                                    ((SingleDecision)decision).addDecision(actionCode);<a name="line.72"></a>
<FONT color="green">073</FONT>                            }<a name="line.73"></a>
<FONT color="green">074</FONT>                            topCandidateIndex++;<a name="line.74"></a>
<FONT color="green">075</FONT>                    }<a name="line.75"></a>
<FONT color="green">076</FONT>                    addCandidateIndex++;<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>            <a name="line.79"></a>
<FONT color="green">080</FONT>            /**<a name="line.80"></a>
<FONT color="green">081</FONT>             * Adds a candidate to the k-best list<a name="line.81"></a>
<FONT color="green">082</FONT>             * <a name="line.82"></a>
<FONT color="green">083</FONT>             * @param symbol the string representation of candidate action<a name="line.83"></a>
<FONT color="green">084</FONT>             * @throws MaltChainedException<a name="line.84"></a>
<FONT color="green">085</FONT>             */<a name="line.85"></a>
<FONT color="green">086</FONT>            public void add(String symbol) throws MaltChainedException {<a name="line.86"></a>
<FONT color="green">087</FONT>                    if (decision instanceof SingleDecision) {<a name="line.87"></a>
<FONT color="green">088</FONT>                            this.add(((SingleDecision)decision).getDecisionCode(symbol));<a name="line.88"></a>
<FONT color="green">089</FONT>                    }<a name="line.89"></a>
<FONT color="green">090</FONT>            }<a name="line.90"></a>
<FONT color="green">091</FONT>            <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>             * Updates the corresponding single decision with the next value in the k-best list.<a name="line.94"></a>
<FONT color="green">095</FONT>             * <a name="line.95"></a>
<FONT color="green">096</FONT>             * @return true if decision has been updated, otherwise false<a name="line.96"></a>
<FONT color="green">097</FONT>             * @throws MaltChainedException<a name="line.97"></a>
<FONT color="green">098</FONT>             */<a name="line.98"></a>
<FONT color="green">099</FONT>            public boolean updateActionWithNextKBest() throws MaltChainedException {<a name="line.99"></a>
<FONT color="green">100</FONT>                    if (addCandidateIndex != 0 &amp;&amp; topCandidateIndex &lt; addCandidateIndex &amp;&amp; topCandidateIndex &lt; kBestList.size()) {<a name="line.100"></a>
<FONT color="green">101</FONT>                            int actionCode = kBestList.get(topCandidateIndex).getActionCode();<a name="line.101"></a>
<FONT color="green">102</FONT>                            if (decision instanceof SingleDecision) {<a name="line.102"></a>
<FONT color="green">103</FONT>                                    ((SingleDecision)decision).addDecision(actionCode);<a name="line.103"></a>
<FONT color="green">104</FONT>                            }<a name="line.104"></a>
<FONT color="green">105</FONT>                            topCandidateIndex++;<a name="line.105"></a>
<FONT color="green">106</FONT>                            return true;<a name="line.106"></a>
<FONT color="green">107</FONT>                    } <a name="line.107"></a>
<FONT color="green">108</FONT>                    return false;<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>            public int peekNextKBest() {<a name="line.111"></a>
<FONT color="green">112</FONT>                    if (addCandidateIndex != 0 &amp;&amp; topCandidateIndex &lt; addCandidateIndex &amp;&amp; topCandidateIndex &lt; kBestList.size()) {<a name="line.112"></a>
<FONT color="green">113</FONT>                            return kBestList.get(topCandidateIndex).getActionCode();<a name="line.113"></a>
<FONT color="green">114</FONT>                    }<a name="line.114"></a>
<FONT color="green">115</FONT>                    return -1;<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>             * Returns the current size of the k-best list<a name="line.119"></a>
<FONT color="green">120</FONT>             * <a name="line.120"></a>
<FONT color="green">121</FONT>             * @return the current size of the k-best list<a name="line.121"></a>
<FONT color="green">122</FONT>             */<a name="line.122"></a>
<FONT color="green">123</FONT>            public int getCurrentSize() {<a name="line.123"></a>
<FONT color="green">124</FONT>                    return addCandidateIndex;<a name="line.124"></a>
<FONT color="green">125</FONT>                    //return kBestList.size();<a name="line.125"></a>
<FONT color="green">126</FONT>            }<a name="line.126"></a>
<FONT color="green">127</FONT>            <a name="line.127"></a>
<FONT color="green">128</FONT>            /**<a name="line.128"></a>
<FONT color="green">129</FONT>             * Returns the maximum number of candidates in the k-best list.<a name="line.129"></a>
<FONT color="green">130</FONT>             * <a name="line.130"></a>
<FONT color="green">131</FONT>             * @return the maximum number of candidates in the k-best list<a name="line.131"></a>
<FONT color="green">132</FONT>             */<a name="line.132"></a>
<FONT color="green">133</FONT>            public int getK() {<a name="line.133"></a>
<FONT color="green">134</FONT>                    return k;<a name="line.134"></a>
<FONT color="green">135</FONT>            }<a name="line.135"></a>
<FONT color="green">136</FONT>            /**<a name="line.136"></a>
<FONT color="green">137</FONT>             * Sets the maximum number of candidates in the k-best list<a name="line.137"></a>
<FONT color="green">138</FONT>             * <a name="line.138"></a>
<FONT color="green">139</FONT>             * @param k the maximum number of candidates <a name="line.139"></a>
<FONT color="green">140</FONT>             */<a name="line.140"></a>
<FONT color="green">141</FONT>            protected void setK(int k) {<a name="line.141"></a>
<FONT color="green">142</FONT>                    if (k == 0) {<a name="line.142"></a>
<FONT color="green">143</FONT>                            this.k = 1; // the k-best list must contain at least one candidate<a name="line.143"></a>
<FONT color="green">144</FONT>                    } if (k &lt; 0) {<a name="line.144"></a>
<FONT color="green">145</FONT>                            this.k = -1; // this means that the k-best list is unrestricted.<a name="line.145"></a>
<FONT color="green">146</FONT>                    } else {<a name="line.146"></a>
<FONT color="green">147</FONT>                            this.k = k;<a name="line.147"></a>
<FONT color="green">148</FONT>                    }<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>
<FONT color="green">151</FONT>            protected int getTopCandidateIndex() {<a name="line.151"></a>
<FONT color="green">152</FONT>                    return topCandidateIndex;<a name="line.152"></a>
<FONT color="green">153</FONT>            }<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>            protected int getAddCandidateIndex() {<a name="line.155"></a>
<FONT color="green">156</FONT>                    return addCandidateIndex;<a name="line.156"></a>
<FONT color="green">157</FONT>            }<a name="line.157"></a>
<FONT color="green">158</FONT>    <a name="line.158"></a>
<FONT color="green">159</FONT>            /**<a name="line.159"></a>
<FONT color="green">160</FONT>             * Returns a single decision object<a name="line.160"></a>
<FONT color="green">161</FONT>             * <a name="line.161"></a>
<FONT color="green">162</FONT>             * @return a single decision object<a name="line.162"></a>
<FONT color="green">163</FONT>             */<a name="line.163"></a>
<FONT color="green">164</FONT>            public SingleDecision getDecision() {<a name="line.164"></a>
<FONT color="green">165</FONT>                    return decision;<a name="line.165"></a>
<FONT color="green">166</FONT>            }<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>            /**<a name="line.168"></a>
<FONT color="green">169</FONT>             * Sets a reference to the decision that owns the k-best list.<a name="line.169"></a>
<FONT color="green">170</FONT>             * <a name="line.170"></a>
<FONT color="green">171</FONT>             * @param decision a reference to the decision that owns the k-best list<a name="line.171"></a>
<FONT color="green">172</FONT>             */<a name="line.172"></a>
<FONT color="green">173</FONT>            protected void setDecision(SingleDecision decision) {<a name="line.173"></a>
<FONT color="green">174</FONT>                    this.decision = decision;<a name="line.174"></a>
<FONT color="green">175</FONT>            }<a name="line.175"></a>
<FONT color="green">176</FONT>            <a name="line.176"></a>
<FONT color="green">177</FONT>            <a name="line.177"></a>
<FONT color="green">178</FONT>            public int getKBestListSize() {<a name="line.178"></a>
<FONT color="green">179</FONT>                    return kBestList.size();<a name="line.179"></a>
<FONT color="green">180</FONT>            }<a name="line.180"></a>
<FONT color="green">181</FONT>            <a name="line.181"></a>
<FONT color="green">182</FONT>            public ScoredCandidate getCandidate(int i) {<a name="line.182"></a>
<FONT color="green">183</FONT>                    if (i &gt;= kBestList.size()) {<a name="line.183"></a>
<FONT color="green">184</FONT>                            return null;<a name="line.184"></a>
<FONT color="green">185</FONT>                    }<a name="line.185"></a>
<FONT color="green">186</FONT>                    return (ScoredCandidate)kBestList.get(i);<a name="line.186"></a>
<FONT color="green">187</FONT>            }<a name="line.187"></a>
<FONT color="green">188</FONT>            <a name="line.188"></a>
<FONT color="green">189</FONT>            /* (non-Javadoc)<a name="line.189"></a>
<FONT color="green">190</FONT>             * @see java.lang.Object#toString()<a name="line.190"></a>
<FONT color="green">191</FONT>             */<a name="line.191"></a>
<FONT color="green">192</FONT>            public String toString() {<a name="line.192"></a>
<FONT color="green">193</FONT>                    StringBuilder sb = new StringBuilder();<a name="line.193"></a>
<FONT color="green">194</FONT>                    sb.append("[ ");<a name="line.194"></a>
<FONT color="green">195</FONT>                    for (int i = 0; i &lt; addCandidateIndex; i++) {<a name="line.195"></a>
<FONT color="green">196</FONT>                            sb.append(kBestList.get(i));<a name="line.196"></a>
<FONT color="green">197</FONT>                            sb.append(' ');<a name="line.197"></a>
<FONT color="green">198</FONT>                    }<a name="line.198"></a>
<FONT color="green">199</FONT>                    sb.append("] ");<a name="line.199"></a>
<FONT color="green">200</FONT>                    return sb.toString();<a name="line.200"></a>
<FONT color="green">201</FONT>            }<a name="line.201"></a>
<FONT color="green">202</FONT>    }<a name="line.202"></a>




























































</PRE>
</BODY>
</HTML>