1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.linear;
23
24 /**
25 * This interface defines a visitor for the entries of a vector. Visitors
26 * implementing this interface may alter the entries of the vector being
27 * visited.
28 *
29 */
30 public interface RealVectorChangingVisitor {
31 /**
32 * Start visiting a vector. This method is called once, before any entry
33 * of the vector is visited.
34 *
35 * @param dimension the size of the vector
36 * @param start the index of the first entry to be visited
37 * @param end the index of the last entry to be visited (inclusive)
38 */
39 void start(int dimension, int start, int end);
40
41 /**
42 * Visit one entry of the vector.
43 *
44 * @param index the index of the entry being visited
45 * @param value the value of the entry being visited
46 * @return the new value of the entry being visited
47 */
48 double visit(int index, double value);
49
50 /**
51 * End visiting a vector. This method is called once, after all entries of
52 * the vector have been visited.
53 *
54 * @return the value returned by
55 * {@link RealVector#walkInDefaultOrder(RealVectorChangingVisitor)},
56 * {@link RealVector#walkInDefaultOrder(RealVectorChangingVisitor, int, int)},
57 * {@link RealVector#walkInOptimizedOrder(RealVectorChangingVisitor)}
58 * or
59 * {@link RealVector#walkInOptimizedOrder(RealVectorChangingVisitor, int, int)}
60 */
61 double end();
62 }