summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/pattern/map.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2014-08-19 17:10:03 -0400
committerTavian Barnes <tavianator@tavianator.com>2015-10-25 11:03:56 -0400
commit7b09710392d35fb55b52031d447a542d99fc6b4b (patch)
tree270eb927ee8c52ceeb99926ebf4843704775a610 /libdimension/dimension/pattern/map.h
parent200c86b91ea7063d35be3bffc11c5da53c054653 (diff)
downloaddimension-7b09710392d35fb55b52031d447a542d99fc6b4b.tar.xz
Modularize the libdimension codebase.
Diffstat (limited to 'libdimension/dimension/pattern/map.h')
-rw-r--r--libdimension/dimension/pattern/map.h68
1 files changed, 68 insertions, 0 deletions
diff --git a/libdimension/dimension/pattern/map.h b/libdimension/dimension/pattern/map.h
new file mode 100644
index 0000000..7229a24
--- /dev/null
+++ b/libdimension/dimension/pattern/map.h
@@ -0,0 +1,68 @@
+/*************************************************************************
+ * Copyright (C) 2009-2014 Tavian Barnes <tavianator@tavianator.com> *
+ * *
+ * This file is part of The Dimension Library. *
+ * *
+ * The Dimension 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 3 of the *
+ * License, or (at your option) any later version. *
+ * *
+ * The Dimension 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 program. If not, see *
+ * <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+/**
+ * @file
+ * Generic maps (backend for pigment_maps, etc.).
+ */
+
+/** A map. */
+typedef struct dmnsn_map dmnsn_map;
+
+/**
+ * Create an empty map.
+ * @param[in] pool The memory pool to allocate from.
+ * @param[in] size The size of the objects to store in the map.
+ * @return A map with no entries.
+ */
+dmnsn_map *dmnsn_new_map(dmnsn_pool *pool, size_t size);
+
+/**
+ * Add an entry (a scalar-object pair) to a map.
+ * @param[in,out] map The map to add to.
+ * @param[in] n The index of the entry.
+ * @param[in] obj The value of the entry.
+ */
+void dmnsn_map_add_entry(dmnsn_map *map, double n, const void *obj);
+
+/**
+ * Return the number of entries in a map.
+ * @param[in] map The map to measure.
+ * @return The size of \p map.
+ */
+size_t dmnsn_map_size(const dmnsn_map *map);
+
+/**
+ * Evaluate a map.
+ * @param[in] map The map to evaluate.
+ * @param[in] n The index to evaluate.
+ * @param[out] val The normalized distance of \p n from \p obj1.
+ * @param[out] obj1 The first object.
+ * @param[out] obj2 The second object.
+ */
+void dmnsn_map_evaluate(const dmnsn_map *map, double n,
+ double *val, void *obj1, void *obj2);
+
+/**
+ * Apply a callback to each element of a map.
+ * @param[in,out] map The map.
+ * @param[in] callback The callback to apply to the elements.
+ */
+void dmnsn_map_apply(dmnsn_map *map, dmnsn_callback_fn *callback);