summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/geometry/Space.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/apache/commons/math3/geometry/Space.java')
-rw-r--r--src/main/java/org/apache/commons/math3/geometry/Space.java47
1 files changed, 47 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/geometry/Space.java b/src/main/java/org/apache/commons/math3/geometry/Space.java
new file mode 100644
index 0000000..7b563c6
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/geometry/Space.java
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.math3.geometry;
+
+import org.apache.commons.math3.exception.MathUnsupportedOperationException;
+
+import java.io.Serializable;
+
+/**
+ * This interface represents a generic space, with affine and vectorial counterparts.
+ *
+ * @see Vector
+ * @since 3.0
+ */
+public interface Space extends Serializable {
+
+ /**
+ * Get the dimension of the space.
+ *
+ * @return dimension of the space
+ */
+ int getDimension();
+
+ /**
+ * Get the n-1 dimension subspace of this space.
+ *
+ * @return n-1 dimension sub-space of this space
+ * @see #getDimension()
+ * @exception MathUnsupportedOperationException for dimension-1 spaces which do not have
+ * sub-spaces
+ */
+ Space getSubSpace() throws MathUnsupportedOperationException;
+}