mineutilscpp

描述

开发目的：C++的便利功能封装，用于方便自己编程和锻炼代码文档规范性，文本使用UTF8-SIG编码。

开发原则：代码基于C++11标准，开发优先级大致为：功能实现 > 类型检查 > 接口简洁 > 性能优化 > 可读性。

命名空间：除宏外所有功能都在mineutils下，同时根据所属模块分布在次级的命名空间，如mineutils::mstr；基于第三方库的功能统一在mineutils::mext下。

命名风格：类命名一律大驼峰；函数命名一律小驼峰；对象式宏统一大写，以MINE_作为前缀；函数式宏统一小驼峰命名，以m为前缀。

线程安全：所有非成员函数接口都保证自身线程安全；成员函数和函数对象接口除非明确说明，否则不保证线程安全。

更新规则：更新遵循大版本号删改接口，中版本号添加新功能接口，小版本号修复和优化的原则。

兼容性声明

大版本内保证接口的代码级兼容性，但以下情况除外：

未明确指定签名的函数作为参数：例如std::thread(func, args...)或mtype::FuncChecker<decltype(func)>。由于后续可能增加函数重载，这类情况下可能会导致不兼容。

混用类型别名与其内部实现：例如mtime::TimePoint在不同版本可能对应std::chrono::high_resolution_clock::time_point或std::chrono::steady_clock::time_point。类型别名的内部实现可能变化，如果混用类型别名与它当前的实际类型，未来更新不保证兼容。

版本信息

当前库版本：1.15.0
文档注释修改日期：20241219

测试平台

Windows:
VS2019
Linux:
x86_64-linux-gnu-gcc 9.4.0
arm-linux-gnueabihf-gcc 8.3.0
QNX660:
arm-unknown-nto-qnx6.6.0eabi-gcc 4.7.3
注： qnx660上编译时需要额外添加g++指令：-D_GLIBCXX_USE_NANOSLEEP

使用方法

可以单独导入./mineutilshpp/modules下的模块，如：

#include"mineutilshpp/modules/time.hpp"   //导入时间相关功能 
#include"mineutilshpp/modules/io.hpp"   //导入输入打印相关功能

也可一键导入mineutilshpp/__*utils__.h，如：

#include"mineutilshpp/__stdutils__.h"   //一键导入基于标准库的功能封装  
#include"mineutilshpp/__cvutils__.h"   //一键导入基于标准库+OpenCV库的功能封装，需要自行添加OpenCV库
#include"mineutilshpp/__mineutils__.h"   //一键导入所有的功能封装，当前包含OpenCV和NCNN的功能，需要自行添加这两个库

然后通过using namespace mineutils使用命名空间mineutils。由于所有功能都分布在次级的命名空间下，因此不用担心污染全局命名空间。

最后根据模块使用其中的功能，如mstr::toStr(123)。
在Linux上可以通过strings xxx | grep version命令查找应用使用的mineutils库版本。

注：以下划线开头的函数和类不建议外部使用，这些仅用于内部功能实现，可能随时删改。

模块介绍

模块	功能
__stdutils__.h	基于C/C++标准库实现的mineutils库部分功能。
__cvutils__.h	基于C/C++标准库和OpenCV库实现的mineutils库部分功能。
__mineutils__.h	mineutils库的全部功能，目前依赖OpenCV和NCNN。
base.hpp	mineutils库的版本信息及完整实现需要的基本工具。包含于mineutils::mbase。
str.hpp	std::string字符串的便捷操作，如转换为字符串、分割字符串等。包含于mineutils::mstr。
time.hpp	时间相关的便捷操作，如计时、休眠等。包含于mineutils::mtime。
type.hpp	类型相关操作，提供可用于模板推导的类型检查功能。包含于mineutils::mtype。
log.hpp	运行日志相关操作，目前包含生成统一格式的运行信息等。包含于mineutils::mlog。
file.hpp	文件操作，目前包含ini文件的读写等。包含于mineutils::mfile。
path.hpp	路径相关操作，如exists、listDir、join、makeDirs等便捷功能。包含于mineutils::mpath。
math.hpp	数学相关的操作，目前包含索引标准化、矩形框操作等。包含mineutils::mmath。
io.hpp	输入输出相关功能，目前包含print函数和main函数参数解析工具。包含于mineutils::mio。
cv.hpp	OpenCV相关便捷功能，如快捷显示、快捷绘制矩形框、打印cv::Mat数据等。包含于mineutils::mext和mineutils::mio。
ncnn.hpp	NCNN相关便捷功能，如快捷运行网络、打印ncnn::Mat数据等。包含于mineutils::mext和mineutils::mio。

注：除了函数和类接口之外，还存在宏定义实现的功能。对象式宏统一大写，以MINE_作为前缀；函数式宏统一小驼峰命名，以m为前缀。

模块功能示例

base.hpp:

...

int main()
{
    std::string version = mbase::getVersion();   //获取mineutils库版本
    
    ...
}

time.hpp:

...

int main()
{
    //普通计时
    auto start_t = mtime::now();
    ...  //do something
    auto end_t = mtine::now();
    long long cost_time = mtime::ms(end_t - start_t);
    
    //统计并打印代码段平均耗时
    mtime::MeanTimeCounter time_counter(10);
    while(true)
    {
        time_counter.addStart("part1");
        ...  // do something1
        time_counter.addEnd("part1");
        
        time_counter.addStart("part2");
        ...  // do something2
        time_counter.addEnd("part2");
        
        time_counter.printAllMeanTimeCost(mtime::Unit::ms);   //每10次循环计算并打印一次平均耗时
    }
    
    //快速统计并打印代码段耗时
    {
        LocalTimeCounter local_counter("part3", mtime::Unit::ms);
        ...  // do something3
    }   //离开作用域时统计并打印耗时
    
    ...
}

type.hpp:

...

template<class T, typename std::enable_if<mtype::InTypesChecker<T, int, char, long long>::value, int>::type = 0>
void func1(T d)   //限制T必须为int、char、long long中的一个类型
{
    do something...
}

template<class T, typename std::enable_if<!mtype::InTypesChecker<T, int, char, long long>::value, int>::type = 0>
void func1(T d)
{
    do something...
}

int main()
{
    //根据参数类型选择合适的重载
    int x = 1;
    double y = 1.5;
    func1(x);   //进入第一个重载
    func1(y);   //进入第二个重载
    
    ...
}

str.hpp:

...

int main()
{
    //填充数字
    std::string s2 = mstr::zfillInt(5, 3, '0');   //返回"005"
    
    //参数填入字符串
    std::string s3 = mstr::fstr("{} has {} billion people.", "China", "1.4");   //返回"China has 1.4 billion people."
    
    //字符串分割
    std::string s4 = " hello world! ";
    std::vector res = mstr::split(s4);   //返回vector{"hello", "world!"};
    
    ...
}

log.hpp:

...

int main()
{
    //创建警告或错误信息
    std::string strw = mmsg("Be careful, {}!", "Bob");   //返回"!Warning! "fileXX"[funcXX](line XX): Be careful, Bob!"
    mprintfE("Dangerous, %s!", "Bob");   //打印"!!!Error!!! "fileXX"[funcXX](line XX): Dangerous, Bob!"
    
    ...
}

file.hpp:

...

int main()
{
    //创建.ini文件，写入内容并读取
    mfile::IniFile ini;
    ini.open("./cfg.ini");
    ini.setValue("key1", "99");
    ini.close();
    ini.open("./cfg.ini");
    std::string value1 = ini.getValue("key1");   //返回"99"
    ini.close();
    
    ...
}

path.hpp:

...

int main()
{
    //判断路径是否存在
    bool res1 = mpath::exists("cfg.ini");

    //判断路径是否是真实目录
    bool res2 = mpath::isDir("cfg.ini");

    //拼接路径
    std::string path1 = mpath::join("A", "B", "C");   //返回"A/B/C"

    //返回当前目录下所有文件目录名或路径
    std::vector<std::string> files1 = mpath::listDir("./", false);

    //返回当前目录及子目录下所有文件名或路径
    std::vector<std::string> files2 = mpath::walk("./", false);

    //创建、删除目录和文件
    mpath::makeDirs("A/B/C");
    mpath::remove("A");
    
    ...
}

math.hpp:

...

int main()
{
    //标准化索引值，Python风格转为C++风格
    int arr[5] = { 0,1,2,3,4 };
    int py_idx = -3;
    int cpp_idx = mmath::normIdx(py_idx, 5);   //返回 2

    //创建不同类型的矩形框并相互转换
    mmath::LTRB ltrb(0, 0, 100, 100);   //{left, top, right, bottom}
    mmath::XYWH xywh = ltrb.toXYWH();   //{center_x, center_y, width, height}
    mmath::LTWH ltwh = ltrb.toLTWH();   //{left, top, width, height}
    
    ...
}

thread.hpp:

...

struct Args
{
    const char* name = "Args";
};

int testFunc1(Args& args)
{
    printf("%s\n", __func__);
    args.name = __func__;
    mtime::sleep(1);
    return 0;
}

class TestFunc2
{
public:
    void testFunc2(void* args)
    {
        printf("%s\n", __func__);
        ((Args*)args)->name = __func__;
        mtime::sleep(1);
    }
};

int main()
{
    mthread::ThreadPool thd_pool(2, 100);
    
    while(true)
    {
        Args args1;
        Args args2;
        TestFunc2 test_func2;

        auto task_state1 = thd_pool.addTask(testFunc1, std::ref(args1));
        auto task_state2 = thd_pool.addTask(&TestFunc2::testFunc2, &test_func2, &args2);

        task_state1.wait();
        task_state2.wait();
        
        ...
    } 
}

io.hpp:

...

class MyClass {};

int main()
{
    //类似Python里的print函数，打印任意类型对象，不支持的类型将会打印<classname: address>
    int a = 10;
    float b = 10.5;
    std::string c = "ccc";
    int d[3] = { 0, 1, 2 };
    std::vector<int> vec = { 1,2,3 };
    auto cvmat = cv::Mat::zeros(3, 5, CV_8UC3);
    cv::Rect2d rect0(0, 0, 100, 200);
    MyClass mc;
    void* p = &mc;
    mio::print(a, b, c, d, vec, cvmat, rect0, mc, p);
    
    /*    打印内容如下：
    10 10.5 ccc {0 1 2} {1 2 3}
    cv::Mat{[(0 0 0) (0 0 0) (0 0 0) (0 0 0) (0 0 0)]
            [(0 0 0) (0 0 0) (0 0 0) (0 0 0) (0 0 0)]
            [(0 0 0) (0 0 0) (0 0 0) (0 0 0) (0 0 0)]}
     [100 x 200 from (0, 0)] <class MyClass: 0x0000008E111BF528> 0000008E111BF528
    */
    
    ...
}

cv.hpp:

...

int main()
{
    //快捷设置一个{720, 480}尺寸，左上角在{0, 0}处的窗口
    setWindowCV("win", {720, 480}, {0, 0}, cv::WINDOW_FREERATIO) 
    
    //快捷设置窗口并显示
    cv::Mat img = cv::imread("001.jpg");
    int k = mext::quickShowCV("win", img, 1, false, {720, 480}, {0, 0}, cv::WINDOW_FREERATIO);
    if (k == 27)
    {
        cv::destroyWindow("win");
        return -1;
    }
    
    //快捷绘制标签
    mext::putBoxCV(img, {10, 10, 60, 100}, "car");
    
    //输出cv::Mat 20-24列、50-51行、第0通道区域的值
    mext::printMat(img, {20, 25}, {50, 52}, {0, 1});
    
    ...
}

ncnn.hpp:

...

int main()
{
    //快捷加载ncnn模型
    ncnn::Net net;
    int ret = mext::loadNcnn(net, "net.param", "net.bin");
    if (ret != 0)
        return -1;
        
    //快捷运行ncnn网络推理
    cv::Mat img = cv::imread("001.jpg");
    ncnn::Mat inp = ncnn::Mat::from_pixels(img.data, ncnn::Mat::PIXEL_BGR2RGB, img.cols, img.rows);
    std::vector<ncnn::Mat> outputs = mext::quickRunNcnn(net, inp, "x", {"y1", "y2", "y3"});
    
    //输出ncnn::Mat 20-24列、50-51行、第0通道区域的值
    mext::printMat(inp, {20, 25}, {50, 52}, {0, 1});
    
    ...
}

版本更新日志

v1.15.0

20241219

mstr下添加trim、ltrim、rtrim函数；
修复被标记为废弃的printfN系列宏编译错误的问题。

v1.14.0

20241210

添加新的mstr::toStr和mstr::fstr重载，用于为浮点数设置精度；
添加一个新的mstr::zfillFlt重载，并将旧的标记为废弃；
显著优化mstr下接口的整体性能，并修复mstr::toStr和基于它的接口可能以非预期的方式表示数字的问题；
修复mtype::StdBindChecker对C数组参数的检查结果；
优化mthread::ThreadPool在析构时的逻辑。

v1.13.0

20241126

mtime::MeanTimeCounter现在包含mtime::MultiMeanTimeCounter的完整功能，同时将mtime::MultiMeanTimeCounter标记为废弃；
mthread::ThreadPool修复在析构时可能触发异常的bug；
修复mstr::fstr无法只接受1个参数的bug；
尽可能将所有标记为废弃的接口都添加静态警告或运行时警告。

v1.12.0

20241125

mpath下添加isFileMatchExts函数，并将isImage和isVideo函数标记为废弃；
mthread::ThreadPauser添加一个setPausePoint的新重载，并优化逻辑和性能；
mthread::ThreadPool简化实现，优化性能，添加一个新的构造函数，并将带wakeup_period_ms参数的构造函数标记为废弃；
mio::ArgumentParser少量优化printPresetOptions和printParsedOptions打印的格式；
mtime::TimePoint将对high_resolution_clock的依赖替换为对steady_clock的依赖；
宏定义MINE_THREAD_LOCAL更名为MINE_THREAD_LOCAL_IF_HAVE，原命名废弃。

v1.11.2

20241112

mthread::ThreadPauser少量性能优化；
mthread::TaskRetState改用std::shared_future来实现，以便多次get；
mio::print消除打印函数时的警告；
mio::ArgumentParser少量逻辑优化。

v1.11.1

20241105

mtype::StdBindChecker可以更准确地处理具有多个operator()重载的仿函数以及std::ref包装的函数和仿函数了，因此mthread::ThreadPool::addTask得到同样的优化；
mtype::StdBindChecker明确限制仿函数和成员函数均满足对象和函数的cv限定符匹配，为此mthread::ThreadPool::addTask得到同样的限制；
QNX的gcc4.7.3对部分SFINAE特性支持不全，如std::declval<ObjT>()->*std::declval<Func>()判断失败会直接报错等等，因此修改了部分mtype下类型检查器的实现；
mtype::FuncChecker处理有多个operator()重载的仿函数时，mtype::FuncChecker::value为false；
mio::print支持打印函数和成员函数。

v1.11.0

20241101

添加mthead::ThreadPauser，用于代替循环sleep来暂停线程；
mtime::MultiMeanTimeCounter添加addLocal成员函数，使用RAII原则实现addStart和addEnd的功能；
mtime内接口统一时间数字用long long类型；
mfile::IniFile::close优化，未打开文件也可以close。

v1.10.1

20241030

mtype::FuncChecker修复对不可拷贝和移动的函数对象编译错误的问题；
mtype::StdBindChecker修复存在的bug并添加对函数对象作为Fn的类型要求；
mthead::ThreadPool::addTask相应添加对函数对象作为Fn的类型要求。

v1.10.0

20241028

mbase添加mlikely和munlikely宏，用于在GCC中使用分支预测优化；
mtype添加RvalueRefMaker、EachLvalueConstructibleChecker等结构体，用于模板检查和类型处理；
mtype::StdBindChecker内部添加更严格的类型检查；mthread::addTask添加更严格的参数类型检查；
MINE_DEPRECATED宏重命名为mdeprecated，保持宏命名风格一致性；mtypename宏废弃，使用mtype::getTypeName函数替换；
mio::ArgumentParser类稍微修改了printPresetOptions和printParsedOptions成员函数打印的格式；
mmath::BaseBox及其子类改为struct，以符合其成员变量公开的设定；
mmath::BaseBox子类的toPixel函数的限制条件更改为仅限整数类型，mmath::及其子类的构造函数添加更优的类型限制；
修复在1.9.0版本中mext::printMat的兼容性被破坏的问题，现在mext::printMat有了更准确的类型限制了。

v1.9.0

20241012

mio添加ArgumentParser类，用于解析main函数参数；
mio::print添加对std::initializer_list的支持，并修复部分函数确实inline的问题；
mpath模块性能优化；
部分代码风格统一。

v1.8.0

20240926

修复mpath::splitName无法分离后缀名的bug；
添加mpath::makeFile函数用于创建文件；
优化mpath整体逻辑以减少性能开销；
修复mfile::IniFile在保存新加入的key-value对时，写入顺序与加入顺序不一致的问题；
mfile::setValue模板中添加对value的类型限制；
mtype添加ConstructibleFromEachChecker、FuncChecker和StdBindChecker等结构体，用于模板检查；
mtype废弃函数isSameType、isInTypes，添加结构体SameTypesChecker、InTypesChecker；
mbase添加mtypename宏，用于获取类型名称字符串。

v1.7.2

20240906

修复std的stream系列的clear()未清空缓存导致的mstr内部分函数的异常。

v1.7.1

20240819

修复mthread::ThreadPool的wakeup_period_ms参数未生效的bug；
对部分接口的参数取值范围进行限制；
修改mtime::sleep系列函数的输入类型为unsigned long。

v1.7.0

20240815

统一函数式宏定义使用m开头，对象式宏定义使用MINE_开头，如printfE现在为mprintfE；
mthread::TaskRetState添加valid()接口；
优化mmath::BaseBox及其派生类的模板类型限制方式，标记mmath::BaseBox::belongToIntSeries为废弃。

v1.6.0

20240729

添加mthread::TaskRetState类，上个版本的mthread::TaskState现在等于mthread::TaskRetState；
mthread::ThreadPool::addTask现在返回mthread::TaskRetState，支持获取任务的返回值；
mmath::align修复对非2的幂计算错误的问题；
添加mtype::StdBeginEndChecker结构体，用于检查类型T是否具有类似于STL容器的begin()和end()接口；
mio::print现在支持所有C++11中的正式STL容器的打印了，并修复了打印不支持类型时的编译错误；
修复QNX的GCC4.7.3编译器的无法编译通过的问题。

v1.5.1

20240704

修改mstr::toOrdinal的实现方式以适配QNX项目；
mfile::IniFile操作增加内部open状态判断。

v1.5.0

20240701

添加thread.hpp模块和线程池类型mthread::ThreadPool类；
优化mio::print的实现方式，并修复缺少无参构造函数的类型无法正确打印的问题；
标记mbase中的BOOL_CASE_TAGS及相关类型为废弃，建议使用std::integral_constant<bool, value>代替。

v1.4.2

20240619

将带参数的mtype::isSameType函数标记为废弃；
mtime::LocalTimeCounter类的打印格式稍作调整。

v1.4.1

20240604

mpath下的函数逻辑优化；
修复MINE_FUNCNAME宏在少数情况下为空的bug。

v1.4.0

20240530

mstr添加toOrdinal函数；
mmath添加align函数；
mmath::BaseBox类的构造函数添加静态断言，要求模板类型必须为整数或浮点数类型；
log.hpp添加MINE_FUNCNAME宏，用于获取namespace::class::function形式的函数名，并相应更改printfN和msgN宏；
mbase添加printVersion函数。

v1.3.0

20240513

log.hpp中简化msgN、printfN、dprintfN的打印信息；
mstr::split函数性能优化，且可以设定最大分割次数，并添加mstr::rsplit函数；
mfile::IniFile使用list+map重写，优化性能；
mpath::isImage添加img_exts形参，mpath::isVideo添加video_exts形参；
将用户接口的声明放到文件的顶部，将内部实现放在底部。

v1.2.1

20240423

修复log.hpp中printfN、printfW、printfE等宏的打印错误。

v1.2.0

20240422

base.hpp添加MINE_FUNCSIG宏用于获得函数信息，添加MINE_DEPRECATED宏用于标记废弃；
log.hpp添加msgW、msgE、printfW、printfE等宏用于生成警告和错误信息；
mlog::messageW、mlog::messageE、mlog::messageN被标记为废弃，将在2.x.y版本中删除；
移动和添加dprntf、dprintfW、dprintfE等宏到log.hpp下，用于调试时使用，由编译器NDEBUG宏控制是否生效；
优化mstr::toStr性能；
mstr::fstr函数不再打印警告信息。

v1.1.0

20240410

time.hpp中更改sleep系列函数的输入参数类型为long long型；
time.hpp添加LocalTimeController类；
mio::print不再对bool类型值打印true和false；
现在在Linux系统上可以通过strings xxx | grep version命令查找版本信息。

v1.0.3

20240112

灵感再次迸发！现在io.hpp中print函数可以打印任意类型的对象了，未支持的类型会打印类名+地址；
随着print函数功能的升级，删去了对OpenCV中cv::Mat和cv::MatExpr之外类型的拓展，这些类型无需拓展即可打印；
修复在qnx上部分模块缺少系统头文件导入的问题。

v1.0.2

20240111

将库中的Tab制表符全部替换为4个空格；
Readme文档更新测试平台。

20240110

优化cv.hpp和ncnn.hpp中printMat函数的打印效果。

v1.0.1

20240108

灵感迸发！现在io.hpp中print函数的功能完整性不再受模块的调用顺序的影响，也不受__*utils__.h的混用影响；
修复了mfile::IniFile类的编译问题、空cfg文件的写入异常。

v1.0.0

20240105

重新组织了mineutils库的结构，形成正式版本；
删除了原本的ColorStr::red、ColorStr::blue等彩色字体字体接口，统一更新为mstr::color接口；
简化message系列函数接口；
其他优化内容。

Name		Name	Last commit message	Last commit date
Latest commit History 29 Commits
mineutilshpp		mineutilshpp
LICENSE		LICENSE
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

mineutilscpp

描述

兼容性声明

大版本内保证接口的代码级兼容性，但以下情况除外：

版本信息

测试平台

使用方法

模块介绍

模块功能示例

base.hpp:

time.hpp:

type.hpp:

str.hpp:

log.hpp:

file.hpp:

path.hpp:

math.hpp:

thread.hpp:

io.hpp:

cv.hpp:

ncnn.hpp:

版本更新日志

About

Releases

Packages

Languages

License

SpiceGL/mineutilscpp

Folders and files

Latest commit

History

Repository files navigation

mineutilscpp

描述

兼容性声明

大版本内保证接口的代码级兼容性，但以下情况除外：

版本信息

测试平台

使用方法

模块介绍

模块功能示例

base.hpp:

time.hpp:

type.hpp:

str.hpp:

log.hpp:

file.hpp:

path.hpp:

math.hpp:

thread.hpp:

io.hpp:

cv.hpp:

ncnn.hpp:

版本更新日志

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages