Class MatrixParameterDescriptors

All Implemented Interfaces:
Serializable, GeneralParameterDescriptor, ParameterDescriptorGroup, IdentifiedObject

public class MatrixParameterDescriptors extends DefaultParameterDescriptorGroup
A parameter group for matrix elements. The amount of parameter values is extensible, i.e. it can grown or shrink according the value of "num_row" and "num_col" parameters. The parameters format may vary according the information provided to the constructor, but it is typically as below:
 num_row
 num_col
 elt_0_0
 elt_0_1
 ...
 elt_0_<num_col-1>
 elt_1_0
 elt_1_1
 ...
 elt_<num_row-1>_<num_col-1>
 
Since:
2.1
Author:
Martin Desruisseaux (IRD)
See Also:
  • Field Details

    • DEFAULT_MATRIX_SIZE

      public static final int DEFAULT_MATRIX_SIZE
      The default matrix size for the one-argument constructor.
      See Also:
    • numRow

      protected final ParameterDescriptor<Integer> numRow
      The descriptor for the "num_row" parameter.
    • numCol

      protected final ParameterDescriptor<Integer> numCol
      The descriptor for the "num_col" parameter.
    • prefix

      protected final String prefix
      The prefix to insert in front of parameter name for each matrix elements.
    • separator

      protected final char separator
      The separator between the row and the column index in parameter names.
  • Constructor Details

    • MatrixParameterDescriptors

      public MatrixParameterDescriptors(Map<String,?> properties)
      Constructs a parameter group with default name format matching Well Known Text usages.
      Parameters:
      properties - Set of properties. Should contains at least "name".
    • MatrixParameterDescriptors

      public MatrixParameterDescriptors(Map<String,?> properties, ParameterDescriptor<?>[] parameters, String prefix, char separator)
      Constructs a parameter group. The properties map is given unchanged to the super-class constructor. The parameters array should contains parameters other than matrix elements. The first parameter is assumed to be the number of rows, and the second parameter the number of columns. All extra parameters are ignored.
      Parameters:
      properties - Set of properties. Should contains at least "name".
      parameters - The "num_row" and "num_col" parameters.
      prefix - The prefix to insert in front of parameter name for each matrix elements.
      separator - The separator between the row and the column index in parameter names.
  • Method Details