View Javadoc
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  import org.hipparchus.FieldElement;
25  
26  /**
27   * This interface defines a visitor for the entries of a vector. Visitors
28   * implementing this interface may alter the entries of the vector being
29   * visited.
30   *
31   * @param <T> the type of the field elements
32   */
33  public interface FieldVectorChangingVisitor<T extends FieldElement<?>> {
34      /**
35       * Start visiting a vector. This method is called once, before any entry
36       * of the vector is visited.
37       *
38       * @param dimension the size of the vector
39       * @param start the index of the first entry to be visited
40       * @param end the index of the last entry to be visited (inclusive)
41       */
42      void start(int dimension, int start, int end);
43  
44      /**
45       * Visit one entry of the vector.
46       *
47       * @param index the index of the entry being visited
48       * @param value the value of the entry being visited
49       * @return the new value of the entry being visited
50       */
51      T visit(int index, T value);
52  
53      /**
54       * End visiting a vector. This method is called once, after all entries of
55       * the vector have been visited.
56       *
57       * @return the value returned after visiting all entries
58       */
59      T end();
60  }