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    *      http://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  package org.apache.commons.math.linear;
19  
20  
21  /**
22   * Interface defining very basic matrix operations.
23   * @version $Revision: 772119 $ $Date: 2009-05-06 05:43:28 -0400 (Wed, 06 May 2009) $
24   * @since 2.0
25   */
26  public interface AnyMatrix {
27  
28      /**
29       * Is this a square matrix?
30       * @return true if the matrix is square (rowDimension = columnDimension)
31       */
32      boolean isSquare();
33  
34      /**
35       * Returns the number of rows in the matrix.
36       *
37       * @return rowDimension
38       */
39      int getRowDimension();
40  
41      /**
42       * Returns the number of columns in the matrix.
43       *
44       * @return columnDimension
45       */
46      int getColumnDimension();
47  
48  }