Package com.openinventor.meshvizxlm.mesh

Enum StorageLayoutIJK

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StorageLayoutIJK>
    public enum StorageLayoutIJK
extends java.lang.Enum<StorageLayoutIJK>
    Hint about data organization in memory for IJK volume mesh.

    This information aims at optimizing the data traversal for extractors. Enum values covering all possible cases for internal data layout in memory. For instance KJI means that:

    • data (i+1,j,k) is consecutive in memory to the data (i,j,k) and,
    • the row of data (j+1,k) is consecutive in memory to the row of data (j,k) and,
    • the slice of data (k+1) is consecutive in memory to the slice of data (k)

    The fastest way to go through the data with such layout is to perform the following triple loop:

     for each k with 0 <= k < numK
   for each j with 0 <= j < numJ
     for each i with 0 <= i < numI

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      IJK  
      IKJ  
      JIK  
      JKI  
      KIJ  
      KJI  
      UNKNOWN
      Means that the data storage organization is unknown, for instance when data are computed on the fly.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static StorageLayoutIJK valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static StorageLayoutIJK[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static StorageLayoutIJK[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (StorageLayoutIJK c : StorageLayoutIJK.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static StorageLayoutIJK valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null