summaryrefslogtreecommitdiff
path: root/gee/hashable.vala
diff options
context:
space:
mode:
Diffstat (limited to 'gee/hashable.vala')
-rw-r--r--gee/hashable.vala44
1 files changed, 44 insertions, 0 deletions
diff --git a/gee/hashable.vala b/gee/hashable.vala
new file mode 100644
index 0000000..8a2c785
--- /dev/null
+++ b/gee/hashable.vala
@@ -0,0 +1,44 @@
+/* hashable.vala
+ *
+ * Copyright (C) 2010 Maciej Piechotka
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Author:
+ * Maciej Piechotka <uzytkwonik2@gmail.com>
+ */
+
+/**
+ * This interface defines a hash function amongs instances of each class
+ * implementing it.
+ *
+ * @see Comparable
+ */
+public interface Gee.Hashable<G> : Object {
+ /**
+ * Computes hash for an objects. Two hashes of equal objects have to be
+ * equal. Hash have to not change during lifetime of object.
+ *
+ * @return hash of an object
+ */
+ public abstract uint hash ();
+
+ /**
+ * Compares this object with the specifed object.
+ *
+ * @return true if objects are equal
+ */
+ public abstract bool equal_to (G object);
+}