Merge pull request #143 from Pressio/139-extents-in-vector-space

addressed extents

Author: fnrizzi

romtools/vector_space/__init__.py

@@ -104,12 +104,12 @@ class VectorSpace(abc.ABC):
     '''
 
     @abc.abstractmethod
-    def get_dimension(self) -> int:
+    def extents(self) -> np.ndarray:
         '''
         Retrieves the dimension of the vector space
 
         Returns:
-            `int`: The dimension of the vector space.
+            `np.ndarray`: The dimension of the vector space (n_var,nx,K).
 
         Concrete subclasses should implement this method to return the
         appropriate dimension for their specific vector space implementation.
@@ -183,14 +183,14 @@ def __init__(self,
         self.__basis = splitter.split(snapshot_matrix)
         self.__basis = orthogonalizer.orthogonalize(self.__basis)
         self.__basis = _matrix_to_tensor(n_var, self.__basis)
-        self.__dimension = self.__basis.shape[2]
+        self.__extents = self.__basis.shape
         self.__shift_vector = shifter.get_shift_vector()
 
-    def get_dimension(self) -> int:
+    def extents(self) -> np.ndarray:
         '''
-        Concrete implementation of `VectorSpace.get_dimension()`
+        Concrete implementation of `VectorSpace.extents()`
         '''
-        return self.__dimension
+        return self.__extents
 
     def get_shift_vector(self) -> np.ndarray:
         '''
@@ -271,14 +271,14 @@ def __init__(self,
         self.__basis = _tensor_to_matrix(self.__basis)
         self.__basis = orthogonalizer.orthogonalize(self.__basis)
         self.__basis = _matrix_to_tensor(n_var, self.__basis)
-        self.__dimension = self.__basis.shape[2]
+        self.__extents = self.__basis.shape
         self.__shift_vector = shifter.get_shift_vector()
 
-    def get_dimension(self) -> int:
+    def extents(self) -> np.ndarray:
         '''
-        Concrete implementation of `VectorSpace.get_dimension()`
+        Concrete implementation of `VectorSpace.extents()`
         '''
-        return self.__dimension
+        return self.__extents
 
     def get_shift_vector(self) -> np.ndarray:
         '''

tests/romtools/test_vector_space.py

@@ -31,7 +31,7 @@ def test_dictionary_vector_space():
     assert np.allclose(my_vector_space.get_basis().flatten(),
                        snapshots.flatten())
     assert np.allclose(my_vector_space.get_shift_vector(), 0)
-    assert np.allclose(my_vector_space.get_dimension(), 6)
+    assert np.allclose(my_vector_space.extents()[-1], 6)
 
     # test with a shift
     my_shifter = utils.create_average_shifter(snapshots)
@@ -43,7 +43,7 @@ def test_dictionary_vector_space():
                       (original_snapshots - np.mean(original_snapshots, axis=2)[:, :, None]).flatten())
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(original_snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 6)
+    assert np.allclose(my_vector_space.extents()[-1], 6)
 
     # test with a shift and splitting
     my_shifter = utils.create_average_shifter(snapshots)
@@ -54,7 +54,7 @@ def test_dictionary_vector_space():
                                                my_splitter)
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 12)
+    assert np.allclose(my_vector_space.extents()[-1], 12)
 
     # test with a shift, splitting, and orthogonalization
     my_shifter = utils.create_average_shifter(snapshots)
@@ -66,7 +66,7 @@ def test_dictionary_vector_space():
                                                my_orthogonalizer)
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 12)
+    assert np.allclose(my_vector_space.extents()[-1], 12)
     basis = my_vector_space.get_basis()
     basis = _tensor_to_matrix(basis)
     assert np.allclose(basis.transpose() @ basis, np.eye(12))
@@ -82,7 +82,7 @@ def test_vector_space_from_pod():
     u, s, v = np.linalg.svd(snapshotMatrix, full_matrices=False)
     basis_tensor = my_vector_space.get_basis()
     assert np.allclose(u.reshape(basis_tensor.shape), basis_tensor)
-    assert np.allclose(6, my_vector_space.get_dimension())
+    assert np.allclose(6, my_vector_space.extents()[-1])
     assert np.allclose(0, my_vector_space.get_shift_vector())
 
     # test with a shift
@@ -93,7 +93,7 @@ def test_vector_space_from_pod():
     assert np.allclose(u.reshape(basis_tensor.shape), basis_tensor) # FAILS
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(original_snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 6)
+    assert np.allclose(my_vector_space.extents()[-1], 6)
 
     # test with a shift and splitting
     snapshots = np.random.normal(size=(3, 8, 6))
@@ -107,7 +107,7 @@ def test_vector_space_from_pod():
     assert np.allclose(u.reshape(basis_tensor.shape), basis_tensor)
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(original_snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 12)
+    assert np.allclose(my_vector_space.extents()[-1], 12)
 
     # test with a shift, splitting, and orthogonalization
     snapshots = np.random.normal(size=(3, 8, 6))
@@ -124,7 +124,7 @@ def test_vector_space_from_pod():
     assert np.allclose(u.reshape(basis_tensor.shape), basis_tensor)
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(original_snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 12)
+    assert np.allclose(my_vector_space.extents()[-1], 12)
 
 
 @pytest.mark.mpi_skip
@@ -139,7 +139,7 @@ def test_trial_space_from_scaled_pod():
     u = u.reshape(basis_tensor.shape)
     u = my_scaler.post_scale(u)
     assert np.allclose(u, basis_tensor), print(u, my_vector_space.get_basis())
-    assert np.allclose(6, my_vector_space.get_dimension())
+    assert np.allclose(6, my_vector_space.extents()[-1])
     assert np.allclose(0, my_vector_space.get_shift_vector())
 
     # test with a shift
@@ -159,7 +159,7 @@ def test_trial_space_from_scaled_pod():
     assert np.allclose(basis_tensor, u) # FAILS
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(original_snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 6)
+    assert np.allclose(my_vector_space.extents()[-1], 6)
 
     # test with a shift and splitting
     snapshots = np.random.normal(size=(3, 8, 6))
@@ -180,7 +180,7 @@ def test_trial_space_from_scaled_pod():
     assert np.allclose(basis_tensor, u)
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(original_snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 12)
+    assert np.allclose(my_vector_space.extents()[-1], 12)
 
     # test with a shift, splitting, and orthogonalization
     snapshots = np.random.normal(size=(3, 8, 6))
@@ -207,7 +207,7 @@ def test_trial_space_from_scaled_pod():
     assert np.allclose(basis_tensor, u)
     assert np.allclose(my_vector_space.get_shift_vector(),
                        np.mean(original_snapshots, axis=2))
-    assert np.allclose(my_vector_space.get_dimension(), 12)
+    assert np.allclose(my_vector_space.extents()[-1], 12)
 
 
 if __name__ == "__main__":

tests/romtools/test_vector_space_svd_mpi.py

@@ -42,7 +42,7 @@ def test_vector_space_from_pod_mpi():
         snaps = construct_snapshots(comm)
         myVectorSpace = rt.VectorSpaceFromPOD(snaps, svdFnc=MyFakeSvd(comm))
         U = myVectorSpace.get_basis()
-        k = myVectorSpace.get_dimension()
+        k = myVectorSpace.extents()[-1]
         if rank == 0:
             assert np.allclose(U, np.zeros((3, 3, 2)))
             assert np.allclose(2, k)