Original, A C++ Tool Library

简介

Original是一个C++基础工具库,也是本人的第一个正式项目，用于学习C++相关基础以及STL、Boost等库。项目的目标是实现STL的主要内容以及Boost的某些相关功能，具体已经实现和未来计划实现的模块内容在下文列出，计划实现的部分会根据情况进行调整，不一定都实现，以最终项目为准。

Github地址

对于相关类和方法文档的查看，

1. 网页端：直接点击上方菜单选项；
2. 移动端：点击左上方菜单折叠栏，展开菜单后点击菜单选项。

如有问题可以在Issues中提出，也欢迎一起参与到本项目的实现中来，如Fork等。

安装

这里以项目hello_original为例：

├─CMakeLists.txt
└─main.cpp

方法一 使用Cmake远程拉取（推荐）：

配置CMakeLists.txt：

cmake_minimum_required(VERSION 3.30)
project(hello_original)
 
set(CMAKE_CXX_STANDARD 20)
 
set(BUILD_TESTING OFF CACHE BOOL "Disable tests in the fetched project")
 
include(FetchContent)
 
FetchContent_Declare(
        original
        GIT_REPOSITORY git@github.com:FrozenLemonTee/original.git
        GIT_TAG master
)
 
FetchContent_MakeAvailable(original)
 
add_executable(hello_original main.cpp)
 
 
target_link_libraries(hello_original PRIVATE original)

方法二 使用Cmake本地构建、安装：

在该项目文件夹下新建文件夹build并进入：

mkdir build
cd build

利用cmake构建库：

cmake .. -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=OFF
cmake --build . --config Debug
cmake --install . --config Debug

将生成的build和install文件夹复制到项目hello_original中。

复制后项目的结构如下：

├─build
├─install
├─CMakeLists.txt
└─main.cpp

配置CMakeLists.txt：

cmake_minimum_required(VERSION 3.30)
project(hello_original)
 
set(CMAKE_CXX_STANDARD 20)
 
set(CMAKE_PREFIX_PATH "${CMAKE_SOURCE_DIR}/install/cmake")
list(APPEND CMAKE_PREFIX_PATH "${CMAKE_SOURCE_DIR}/install/cmake/original")
 
find_package(original REQUIRED)
 
add_executable(hello_original main.cpp)
 
target_link_libraries(hello_original PRIVATE "${ORIGINAL_LIBRARIES}")

接下来展示测试Demo：

main.cpp：

 ++
#include <iostream>
#include "original.h"
 
 
int main() {
    std::cout << "Hello, Original!" << std::endl;
    auto a1 = original::array({"Hello, Original!"});
    std::cout << a1 << std::endl;
    printf("%s\n", static_cast<const char*>(a1));
    return 0;
}

输出：

Hello, original!
array("Hello, original!")
array("Hello, original!")

模块进度

Core

正在实现中。已实现部分：

容器：

定长容器：定长数组 array，位集合 bitSet，变长容器：变长数组 vector，单向链表 forwardChain，双向链表 chain，块状链表 blocksList，关联容器：映射表 hashMap，集合 hashSet

容器接口：

格式化输出接口 printable，元素比较接口 comparable，堆对象深拷贝接口 cloneable，可迭代接口 iterable

算法库：

布尔算法：allOf/anyOf/noneOf...，非修改算法 find/count/equal...，修改算法 fill/swap/forEach/...，排序算法 sort/stableSort/introSort...

容器适配器：

栈 stack，队列 queue，双端队列 deque，优先队列 prique

算法适配器：

迭代器 iterator/iterAdaptor，变换器 transform/transformStream，过滤器 filter/filterStream，比较器 comparator

异常安全：

运行时异常 error/outOfBoundError/unSupportedMethodError/allocateError...，编译期错误 staticError

编译期工具：

二元组 couple，多元组 tuple

内存管理：

自动指针 ownerPtr/strongPtr/weakPtr，分配器 allocatorBase/allocator/objPoolAllocator，删除器 deleterBase/deleter

asyncIO

计划实现，包含多线程和网络通信功能。

matrix

计划实现，包含张量，线性代数工具功能。

graph

计划实现，包含图论结构和图算法。