diff options
Diffstat (limited to 'include')
29 files changed, 68 insertions, 34 deletions
diff --git a/include/framework/DynamicExtension.h b/include/framework/DynamicExtension.h index edbb6f5..7244856 100644 --- a/include/framework/DynamicExtension.h +++ b/include/framework/DynamicExtension.h @@ -4,7 +4,7 @@ * 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. * */ #pragma once diff --git a/include/framework/QueryRequirements.h b/include/framework/QueryRequirements.h index ff4eaff..4d3e97b 100644 --- a/include/framework/QueryRequirements.h +++ b/include/framework/QueryRequirements.h @@ -3,9 +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 header file containing the necessary includes for Shard + * A header file containing the necessary includes for Query * development. * */ diff --git a/include/framework/ShardRequirements.h b/include/framework/ShardRequirements.h index 55e7199..d054030 100644 --- a/include/framework/ShardRequirements.h +++ b/include/framework/ShardRequirements.h @@ -3,7 +3,7 @@ * * 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 header file containing the necessary includes for Shard * development. diff --git a/include/framework/interface/Query.h b/include/framework/interface/Query.h index 21cadcb..8b92c45 100644 --- a/include/framework/interface/Query.h +++ b/include/framework/interface/Query.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/framework/interface/Record.h b/include/framework/interface/Record.h index bf495df..457078d 100644 --- a/include/framework/interface/Record.h +++ b/include/framework/interface/Record.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * * FIXME: the record implementations could probably be broken out into * different files, leaving only the interface here diff --git a/include/framework/interface/Scheduler.h b/include/framework/interface/Scheduler.h index 63581d2..a8544a7 100644 --- a/include/framework/interface/Scheduler.h +++ b/include/framework/interface/Scheduler.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/framework/interface/Shard.h b/include/framework/interface/Shard.h index 92cdca0..2357795 100644 --- a/include/framework/interface/Shard.h +++ b/include/framework/interface/Shard.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/framework/scheduling/Epoch.h b/include/framework/scheduling/Epoch.h index 0ebbde9..9193b06 100644 --- a/include/framework/scheduling/Epoch.h +++ b/include/framework/scheduling/Epoch.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/framework/scheduling/FIFOScheduler.h b/include/framework/scheduling/FIFOScheduler.h index 1521eb6..ba62f9e 100644 --- a/include/framework/scheduling/FIFOScheduler.h +++ b/include/framework/scheduling/FIFOScheduler.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/framework/scheduling/SerialScheduler.h b/include/framework/scheduling/SerialScheduler.h index 93611d1..10c2af2 100644 --- a/include/framework/scheduling/SerialScheduler.h +++ b/include/framework/scheduling/SerialScheduler.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * * IMPORTANT: This "scheduler" is a shim implementation for allowing * strictly serial, single-threaded operation of the framework. It should diff --git a/include/framework/scheduling/Task.h b/include/framework/scheduling/Task.h index 6dfd7df..d211fb5 100644 --- a/include/framework/scheduling/Task.h +++ b/include/framework/scheduling/Task.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/framework/structure/BufferView.h b/include/framework/structure/BufferView.h index ccd3dac..651e430 100644 --- a/include/framework/structure/BufferView.h +++ b/include/framework/structure/BufferView.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/framework/structure/ExtensionStructure.h b/include/framework/structure/ExtensionStructure.h index 80ec7b9..74cede6 100644 --- a/include/framework/structure/ExtensionStructure.h +++ b/include/framework/structure/ExtensionStructure.h @@ -4,7 +4,7 @@ * 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. * */ #pragma once diff --git a/include/framework/structure/InternalLevel.h b/include/framework/structure/InternalLevel.h index 632fe17..00e0c58 100644 --- a/include/framework/structure/InternalLevel.h +++ b/include/framework/structure/InternalLevel.h @@ -4,7 +4,7 @@ * 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. * */ #pragma once diff --git a/include/framework/structure/MutableBuffer.h b/include/framework/structure/MutableBuffer.h index ba25cc3..671824f 100644 --- a/include/framework/structure/MutableBuffer.h +++ b/include/framework/structure/MutableBuffer.h @@ -4,7 +4,7 @@ * 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. * */ #pragma once diff --git a/include/framework/util/Configuration.h b/include/framework/util/Configuration.h index ec4ec3a..866128a 100644 --- a/include/framework/util/Configuration.h +++ b/include/framework/util/Configuration.h @@ -3,7 +3,7 @@ * * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> * - * All rights reserved. Published under the Modified BSD License. + * Distributed under the Modified BSD License. * */ #pragma once diff --git a/include/query/irs.h b/include/query/irs.h index 4cb69b0..fa69ea1 100644 --- a/include/query/irs.h +++ b/include/query/irs.h @@ -3,7 +3,11 @@ * * 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 query class for independent range sampling. This query requires + * that the shard support get_lower_bound(key), get_upper_bound(key), + * and get_record_at(index). * */ #pragma once diff --git a/include/query/rangequery.h b/include/query/rangequery.h index b9ac9db..16dcd86 100644 --- a/include/query/rangequery.h +++ b/include/query/rangequery.h @@ -1,10 +1,12 @@ /* * include/query/rangequery.h * - * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> + * 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 query class for single dimensional range queries. This query requires + * that the shard support get_lower_bound(key) and get_record_at(index). */ #pragma once diff --git a/include/query/wirs.h b/include/query/wirs.h index 1113b1d..9b3d2ad 100644 --- a/include/query/wirs.h +++ b/include/query/wirs.h @@ -3,7 +3,11 @@ * * 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 query class for weighted independent range sampling. This + * class is tightly coupled with include/shard/AugBTree.h, and + * so is probably of limited general utility. * */ #pragma once diff --git a/include/query/wss.h b/include/query/wss.h index 794485c..4c8861e 100644 --- a/include/query/wss.h +++ b/include/query/wss.h @@ -1,10 +1,13 @@ /* - * include/query/rangequery.h + * include/query/wss.h * - * Copyright (C) 2023 Douglas B. Rumbaugh <drumbaugh@psu.edu> + * 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 query class for weighted set sampling. This + * class is tightly coupled with include/shard/Alias.h, + * and so is probably of limited general utility. */ #pragma once 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 diff --git a/include/util/Cursor.h b/include/util/Cursor.h index 00afaab..be7ab32 100644 --- a/include/util/Cursor.h +++ b/include/util/Cursor.h @@ -4,7 +4,7 @@ * 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 simple record cursor type with associated methods for help in * merging record sets when constructing shards. diff --git a/include/util/bf_config.h b/include/util/bf_config.h index 4de465d..fdf2195 100644 --- a/include/util/bf_config.h +++ b/include/util/bf_config.h @@ -4,10 +4,10 @@ * 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. * * Global parameters for configuring bloom filters used as auxiliary - * structures on shards within the framework. The bloom filters themselves + * structures on shards within the framework. The bloom filter class * can be found in * * $PROJECT_ROOT/external/psudb-common/cpp/include/psu-ds/BloomFilter.h diff --git a/include/util/types.h b/include/util/types.h index b7f9607..3908174 100644 --- a/include/util/types.h +++ b/include/util/types.h @@ -3,7 +3,7 @@ * * 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 centralized header file for various data types used throughout the * code base. There are a few very specific types, such as header formats, |