Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/linear/RealMatrixChangingVisitor.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> <a name="line.17"></a> <FONT color="green">018</FONT> package org.apache.commons.math.linear;<a name="line.18"></a> <FONT color="green">019</FONT> <a name="line.19"></a> <FONT color="green">020</FONT> /**<a name="line.20"></a> <FONT color="green">021</FONT> * Interface defining a visitor for matrix entries.<a name="line.21"></a> <FONT color="green">022</FONT> *<a name="line.22"></a> <FONT color="green">023</FONT> * @see DefaultRealMatrixChangingVisitor<a name="line.23"></a> <FONT color="green">024</FONT> * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $<a name="line.24"></a> <FONT color="green">025</FONT> * @since 2.0<a name="line.25"></a> <FONT color="green">026</FONT> */<a name="line.26"></a> <FONT color="green">027</FONT> public interface RealMatrixChangingVisitor {<a name="line.27"></a> <FONT color="green">028</FONT> <a name="line.28"></a> <FONT color="green">029</FONT> /**<a name="line.29"></a> <FONT color="green">030</FONT> * Start visiting a matrix.<a name="line.30"></a> <FONT color="green">031</FONT> * <p>This method is called once before any entry of the matrix is visited.</p><a name="line.31"></a> <FONT color="green">032</FONT> * @param rows number of rows of the matrix<a name="line.32"></a> <FONT color="green">033</FONT> * @param columns number of columns of the matrix<a name="line.33"></a> <FONT color="green">034</FONT> * @param startRow Initial row index<a name="line.34"></a> <FONT color="green">035</FONT> * @param endRow Final row index (inclusive)<a name="line.35"></a> <FONT color="green">036</FONT> * @param startColumn Initial column index<a name="line.36"></a> <FONT color="green">037</FONT> * @param endColumn Final column index (inclusive)<a name="line.37"></a> <FONT color="green">038</FONT> */<a name="line.38"></a> <FONT color="green">039</FONT> void start(int rows, int columns,<a name="line.39"></a> <FONT color="green">040</FONT> int startRow, int endRow, int startColumn, int endColumn);<a name="line.40"></a> <FONT color="green">041</FONT> <a name="line.41"></a> <FONT color="green">042</FONT> /**<a name="line.42"></a> <FONT color="green">043</FONT> * Visit one matrix entry.<a name="line.43"></a> <FONT color="green">044</FONT> * @param row row index of the entry<a name="line.44"></a> <FONT color="green">045</FONT> * @param column column index of the entry<a name="line.45"></a> <FONT color="green">046</FONT> * @param value current value of the entry<a name="line.46"></a> <FONT color="green">047</FONT> * @return the new value to be set for the entry<a name="line.47"></a> <FONT color="green">048</FONT> * @throws MatrixVisitorException if something wrong occurs<a name="line.48"></a> <FONT color="green">049</FONT> */<a name="line.49"></a> <FONT color="green">050</FONT> double visit(int row, int column, double value)<a name="line.50"></a> <FONT color="green">051</FONT> throws MatrixVisitorException;<a name="line.51"></a> <FONT color="green">052</FONT> <a name="line.52"></a> <FONT color="green">053</FONT> /**<a name="line.53"></a> <FONT color="green">054</FONT> * End visiting a matrix.<a name="line.54"></a> <FONT color="green">055</FONT> * <p>This method is called once after all entries of the matrix have been visited.</p><a name="line.55"></a> <FONT color="green">056</FONT> * @return the value that the <code>walkInXxxOrder</code> must return<a name="line.56"></a> <FONT color="green">057</FONT> */<a name="line.57"></a> <FONT color="green">058</FONT> double end();<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> </PRE> </BODY> </HTML>