Skip to content

Commit f90422d

Browse files
author
dingbin
committed
import project for indexed-priority-queue
0 parents  commit f90422d

23 files changed

+1416
-0
lines changed

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.cpp linguist-language=c++

‎INSTALL.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
### IndexedPriorityQueue 编译和安装
2+
3+
目前支持类Unix环境下编译安装，IndexedPriorityQueue 项目依赖的第三方库有：
4+
- tulip-log
5+
- cppunit
6+
7+
编译安装IndexedPriorityQueue之前先要安装以上2个依赖库。
8+
9+
具体编译和安装方法如下：
10+
11+
```
12+
git clone https://github.com/apollo008/indexed-priority-queue.git indexed-priority-queue.git
13+
cd indexed-priority-queue.git
14+
vim src/CMakeLists.txt
15+
搜索need to set 发现存在第3行和第11行，依次修改如下：
16+
第3行： set(TOP_PROJECT_NAME IndexedPriorityQueue ) 将IndexedPriorityQueue改为你的实际项目名称
17+
第11行： set(${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR /path/to/install/share) 将/path/to/install/share改为share库的安装路径，比如${HOME}/local,注意确保该路径有写权限。修改之后后续不要再改变该路径。
18+
19+
mkdir build-dir
20+
cd build-dir
21+
#安装依赖
22+
cmake -DENABLE_BUILD_SHARE=ON ../src
23+
执行完以上这一步即可完成依赖库。注意不需要再执行make 和make install了。
24+
25+
接下来编译安装indexed-priority-queue,包含单元测试。
26+
#安装indexed-priority-queue
27+
首先保持根目录下CMakeLists.txt第11行修改的内容不再改变；
28+
cd build-dir
29+
rm -rf *
30+
cmake -DCMAKE_INSTALL_PREFIX=/path/to/install ../src
31+
make -j10
32+
#此时 运行ctest 命令可以执行所有的单元测试
33+
make install
34+
35+
```
36+
37+
执行完以上，即可在/path/to/install目录下生成bin、lib、include3个目录。
38+
39+
注意：运行程序bin/indexedpq_test时，需要在当前目录放置tulip-log的日志配置文件logger.conf ，同时该目录下要已经创建好logs 目录供输出文件名滚动的日志文件。logger.conf文件示例见misc/config/logger.conf 。
40+
41+
42+
43+
### 其它
44+
45+
相关细节或其它未尽事宜，可联系 dingbinthu@163.com 探讨咨询。

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
### IndexedPriorityQueue：可索引的优先级队列
2+
3+
IndexedPriorityQueue是C++编程语言实现的开源的可以快速改变某个指定元素值的优先级队列。它通过为优先级队列中每个元素维护一个索引Index值来实现快速修改特定元素值且又保证堆性质的目的。修改元素值得操作为IndexedPriorityQueue::Update方法，它执行的时间复杂度为O（logN) (N为优先队列的大小)。这种数据结构的一个典型应用就是求取海量数据中按某个维度去重后的按另一个维度排序的TopN元素集合。本项目的单元测试代码中给出了该应用场景的一个典型求解方案。
4+
5+
本项目还具有其它如下优势：
6+
7+
1. 本项目中整个数据结构的定义与实现都包含在一个头文件中，且其核心实现不依赖任何第三方库，独立而又精炼，可以直接拷贝该头文件到您的项目直接include，快速满足您的数据结构功能要求。 （注意运行本项目的单元测试代码仍依赖于第三方库cppunit和tulip-log模块，项目中已经包含其源码和编译方法。）
8+
2. 本项目实现的IndexedPriorityQueue数据结构的正确性和性能已经被单元测试中大量实例验证和确认，可放心使用。单元测试部分代码同时还可为您提供关于IndexedPriorityQueue的详实的用法指引。
9+
10+
11+
12+
### 编译和安装
13+
14+
目前支持类Unix环境下编译安装，IndexedPriorityQueue 项目依赖的第三方库有：
15+
- tulip-log
16+
- cppunit
17+
18+
编译安装IndexedPriorityQueue之前先要安装以上2个依赖库。
19+
20+
具体编译和安装方法如下：
21+
22+
```
23+
git clone https://github.com/apollo008/indexed-priority-queue.git indexed-priority-queue.git
24+
cd indexed-priority-queue.git
25+
vim src/CMakeLists.txt
26+
搜索need to set 发现存在第3行和第11行，依次修改如下：
27+
第3行： set(TOP_PROJECT_NAME IndexedPriorityQueue ) 将IndexedPriorityQueue改为你的实际项目名称
28+
第11行： set(${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR /path/to/install/share) 将/path/to/install/share改为share库的安装路径，比如${HOME}/local,注意确保该路径有写权限。修改之后后续不要再改变该路径。
29+
30+
mkdir build-dir
31+
cd build-dir
32+
#安装依赖
33+
cmake -DENABLE_BUILD_SHARE=ON ../src
34+
执行完以上这一步即可完成依赖库。注意不需要再执行make 和make install了。
35+
36+
接下来编译安装indexed-priority-queue,包含单元测试。
37+
#安装indexed-priority-queue
38+
首先保持根目录下CMakeLists.txt第11行修改的内容不再改变；
39+
cd build-dir
40+
rm -rf *
41+
cmake -DCMAKE_INSTALL_PREFIX=/path/to/install ../src
42+
make -j10
43+
#此时 运行ctest 命令可以执行所有的单元测试
44+
make install
45+
46+
```
47+
48+
执行完以上，即可在/path/to/install目录下生成bin、lib、include3个目录。
49+
50+
注意：运行程序bin/indexedpq_test 时，需要在当前目录放置tulip-log的日志配置文件logger.conf ，同时该目录下要已经创建好logs 目录供输出文件名滚动的日志文件。logger.conf文件示例见misc/config/logger.conf 。
51+
52+
在build-dir目录下执行ctest，运行结果如下：
53+
54+
![image-20211221182405979](https://raw.githubusercontent.com/apollo008/picgo/master/img/20211221182406.png)
55+
56+
查看本地的Testing/Temporary/LastTest.log可看到具体的fail细节。
57+
58+
### 其它
59+
60+
相关细节或其它未尽事宜，可联系 dingbinthu@163.com 探讨咨询。
61+

‎misc/config/logger.conf

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
tlog.rootLogger=INFO, tulipAppender,consoleAppender
2+
tlog.appender.tulipAppender=FileAppender
3+
tlog.appender.tulipAppender.max_file_size=3024
4+
tlog.appender.tulipAppender.fileName=logs/app.log
5+
tlog.appender.tulipAppender.flush=false
6+
tlog.appender.tulipAppender.delay_time=1
7+
tlog.appender.tulipAppender.layout=PatternLayout
8+
tlog.appender.tulipAppender.layout.LogPattern=[%%d] [%%t,%%F:%%n -- %%f() %%l] [%%m]
9+
10+
tlog.appender.consoleAppender=ConsoleAppender
11+
tlog.appender.consoleAppender.delay_time=1
12+
tlog.appender.consoleAppender.layout=PatternLayout
13+
tlog.appender.consoleAppender.layout.LogPattern=[%%d] [%%t,%%F:%%n -- %%f() %%l] [%%m]
14+
####################################################################

‎src/CMakeLists.txt

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
cmake_minimum_required(VERSION 3.5)
2+
3+
set(TOP_PROJECT_NAME IndexedPQ) #need set
4+
message(TOP_PROJECT_NAME=${TOP_PROJECT_NAME})
5+
6+
project(${TOP_PROJECT_NAME})
7+
8+
string(TOUPPER ${TOP_PROJECT_NAME} TOP_PROJECT_NAME_UPPER)
9+
message(TOP_PROJECT_NAME_UPPER=${TOP_PROJECT_NAME_UPPER})
10+
11+
set(${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR $ENV{HOME}/local) #need set
12+
message("${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR=${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}")
13+
14+
15+
set(${TOP_PROJECT_NAME_UPPER}_ALL_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
16+
set(${TOP_PROJECT_NAME_UPPER}_ALL_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
17+
message("${TOP_PROJECT_NAME_UPPER}_ALL_SOURCE_DIR=${${TOP_PROJECT_NAME_UPPER}_ALL_SOURCE_DIR}")
18+
message("${TOP_PROJECT_NAME_UPPER}_ALL_BINARY_DIR=${${TOP_PROJECT_NAME_UPPER}_ALL_BINARY_DIR}")
19+
20+
21+
execute_process( COMMAND mkdir -p ${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR})
22+
set(ENV{CC} gcc)
23+
message("CC=$ENV{CC}")
24+
set(ENV{CXX} g++)
25+
message("CXX=$ENV{CXX}")
26+
27+
set(ENV{PATH} ${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}/bin:$ENV{PATH})
28+
message("PATH=$ENV{PATH}")
29+
set(ENV{LD_LIBRARY_PATH} ${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}/lib:$ENV{LD_LIBRARY_PATH})
30+
message("LD_LIBRARY_PATH=$ENV{LD_LIBRARY_PATH}")
31+
32+
add_definitions(-Wall -fPIC -m64 -D_FILE_OFFSET_BITS=64 -std=c++17 -gdwarf-3 -msse4.2)
33+
set (CMAKE_SHARED_LINKER_FLAGS "-rdynamic")
34+
add_definitions(-D_GLIBCXX_USE_CXX11_ABI=0)
35+
36+
enable_testing()
37+
38+
option(ENABLE_BUILD_SHARE "Enable Build Share directory" OFF)
39+
40+
link_directories(
41+
${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}/lib
42+
)
43+
44+
#cmake .. -DENABLE_BUILD_SHARE=ON
45+
if (ENABLE_BUILD_SHARE)
46+
include_directories(
47+
${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}/include
48+
)
49+
link_directories(
50+
${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}/lib
51+
)
52+
53+
add_subdirectory(share/tulip-log)
54+
add_subdirectory(share/cppunit)
55+
else()
56+
include_directories(
57+
${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}/include
58+
)
59+
link_directories(
60+
${${TOP_PROJECT_NAME_UPPER}_DEPEND_PREFIX_DIR}/lib
61+
)
62+
add_subdirectory(main)
63+
endif()
64+
65+
66+
67+
68+
69+
70+
71+

0 commit comments

Comments
 (0)