summaryrefslogtreecommitdiffstats
path: root/include/shard
diff options
context:
space:
mode:
authorDouglas Rumbaugh <dbr4@psu.edu>2023-11-07 15:34:24 -0500
committerDouglas Rumbaugh <dbr4@psu.edu>2023-11-07 15:34:24 -0500
commit357cab549c2ed33970562b84ff6f83923742343d (patch)
tree0400b0cbb150821adc8733c55e675d470b993c89 /include/shard
parent355ddd7b595fce201c305caecea415ab325e170e (diff)
downloaddynamic-extension-357cab549c2ed33970562b84ff6f83923742343d.tar.gz
Comment and License updates
Diffstat (limited to 'include/shard')
-rw-r--r--include/shard/Alias.h6
-rw-r--r--include/shard/AugBTree.h6
-rw-r--r--include/shard/ISAMTree.h4
-rw-r--r--include/shard/PGM.h6
-rw-r--r--include/shard/TrieSpline.h4
-rw-r--r--include/shard/VPTree.h7
6 files changed, 27 insertions, 6 deletions
diff --git a/include/shard/Alias.h b/include/shard/Alias.h
index a4a7d02..a3e8ad8 100644
--- a/include/shard/Alias.h
+++ b/include/shard/Alias.h
@@ -4,7 +4,11 @@
* Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu>
* Dong Xie <dongx@psu.edu>
*
- * All rights reserved. Published under the Modified BSD License.
+ * Distributed under the Modified BSD License.
+ *
+ * A shard shim around the psudb::Alias Walker's Alias
+ * structure. Designed to be used along side the WSS
+ * query in include/query/wss.h
*
*/
#pragma once
diff --git a/include/shard/AugBTree.h b/include/shard/AugBTree.h
index e32ec64..be664ac 100644
--- a/include/shard/AugBTree.h
+++ b/include/shard/AugBTree.h
@@ -4,8 +4,12 @@
* Copyright (C) 2023 Dong Xie <dongx@psu.edu>
* Douglas B. Rumbaugh <drumbaugh@psu.edu>
*
- * All rights reserved. Published under the Modified BSD License.
+ * Distributed under the Modified BSD License.
*
+ * A shard shim around the alias augmented B-tree. Designed to be
+ * used along side the WIRS query in include/query/wirs.h, but
+ * also supports the necessary methods for other common query
+ * types.
*/
#pragma once
diff --git a/include/shard/ISAMTree.h b/include/shard/ISAMTree.h
index a610c09..e11c899 100644
--- a/include/shard/ISAMTree.h
+++ b/include/shard/ISAMTree.h
@@ -4,7 +4,9 @@
* Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu>
* Dong Xie <dongx@psu.edu>
*
- * All rights reserved. Published under the Modified BSD License.
+ * Distributed under the Modified BSD License.
+ *
+ * A shard shim around an in-memory ISAM tree.
*
*/
#pragma once
diff --git a/include/shard/PGM.h b/include/shard/PGM.h
index 6b66b7d..13db26a 100644
--- a/include/shard/PGM.h
+++ b/include/shard/PGM.h
@@ -2,8 +2,12 @@
* include/shard/PGM.h
*
* Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu>
+ * Dong Xie <dongx@psu.edu>
*
- * All rights reserved. Published under the Modified BSD License.
+ * Distributed under the Modified BSD License.
+ *
+ * A shard shim around the static version of the PGM learned
+ * index.
*
*/
#pragma once
diff --git a/include/shard/TrieSpline.h b/include/shard/TrieSpline.h
index fdf8edb..56ec357 100644
--- a/include/shard/TrieSpline.h
+++ b/include/shard/TrieSpline.h
@@ -3,7 +3,9 @@
*
* Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu>
*
- * All rights reserved. Published under the Modified BSD License.
+ * Distributed under the Modified BSD License.
+ *
+ * A shard shim around the TrieSpline learned index.
*
*/
#pragma once
diff --git a/include/shard/VPTree.h b/include/shard/VPTree.h
index 978372b..2f5ebbb 100644
--- a/include/shard/VPTree.h
+++ b/include/shard/VPTree.h
@@ -3,7 +3,12 @@
*
* Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu>
*
- * All rights reserved. Published under the Modified BSD License.
+ * Distributed under the Modified BSD License.
+ *
+ * A shard shim around the VPTree spatial index.
+ *
+ * FIXME: separate the KNN query class out into a standalone
+ * file in include/query .
*
*/
#pragma once