cuhkshenzhen / cuhkszlib Goto Github PK

In this test.
还是用中文说吧，这里字符串里用了unicode字符，但是c++的""和对应的std::string只能支持1字节的字符，所以unicode字符会被转换成对应的8位整数。但是在windows上，有保护机制防止字符的取值<0（>128），所以这段代码在windows上会报错。
@Yexiaoxing

we now auto deploy documents using travis ci, but if we push changes to our forks, the test will go wrong since it has no permission.

BinomialDistribution.real_theory
/home/travis/build/cuhkshenzhen/CUHKSZLib/tests/random/BinomialDistributionTest.cpp:24: Failure
Expected: (error_sum / 11) < (0.05), actual: 0.051477 vs 0.05

Reproductive on my macOS sometimes.

https://github.com/codecov/example-cpp11-cmake/blob/master/.travis.yml

Should we include third-party package (like libcurl) to implement network functions? If not I would like to remove this feature for now.

Just click the "face" beside the comment and then "+1" is you like the style.
You can also add new styles.

In my opinion, we just implement big integer num, without decimals. What's your opinion, do you think whether it is necessary to implement decimal?

Like what is said in lecture ...

use some macro to implement a better error msg, so that it can know more.

return std::move(output);
The std::move here can be removed as clang says. Please refer to Copy Elision.

CUHKSZLib/src/json/json_functions.cpp:34:10: warning: moving a local object in a
return statement prevents copy elision [-Wpessimizing-move]
return std::move(output);
#25

Because the system have a math.h, we cannot name the header for math as math.h. I currently name it mathematics.h #19 , any suggestion?

Refer this blog:
http://blog.csdn.net/jinzhuojun/article/details/7881049

Generating docs for file src//home/travis/build/cuhkshenzhen/CUHKSZLib/src/include/json/Json.h:277: warning: argument 'index' of command @param is not found in the argument list of JSONObject::at(const std::string &key)
/home/travis/build/cuhkshenzhen/CUHKSZLib/src/include/json/Json.h:282: warning: The following parameters of cuhksz::JSONObject::at(const std::string &key) are not documented:
  parameter 'key'
/home/travis/build/cuhkshenzhen/CUHKSZLib/src/include/json/Json.h:285: warning: argument 'index' of command @param is not found in the argument list of JSONObject::at(const std::string &key) const
/home/travis/build/cuhkshenzhen/CUHKSZLib/src/include/json/Json.h:289: warning: The following parameters of cuhksz::JSONObject::at(const std::string &key) const are not documented:
  parameter 'key'
/home/travis/build/cuhkshenzhen/CUHKSZLib/src/include/json/Json.h:200: warning: argument 'value' of command @param is not found in the argument list of JSONObject::operator=(T bool_value)
/home/travis/build/cuhkshenzhen/CUHKSZLib/src/include/json/Json.h:207: warning: The following parameters of cuhksz::JSONObject::operator=(T bool_value) are not documented:
  parameter 'bool_value'

@Yexiaoxing

I've write an error macro, please refactor any related error raising statement.
Also, if you have any suggestions to the error macro (it's now a very simple one), modify it or reply here.

1. Finish functional codes.
2. Add test and document and make sure that there's no public function that is not documented or tested.
3. Decide a detailed format guide and format the codes with clang-format. Also deal with some small parts like file naming and include order.
4. Eliminate all warnings and add Werror flags
5. Deal with TODO
6. Make auto github release for the library (I've tested it both on travis and appveyor)
7. Finish report for the course
8. Remove anything about the course from the repo (to make public)
9. Refine style guide and contribution guide

Things to do if we decide to make public:

1. Add under development in readme.md and tags
2. Remove the proposal.

If you agree or disagree, please reply below.
@cuhkshenzhen/library-dev

Which license should we use to open-source our code?
Some possible choice:
MIT
WTFPL
Apache
Mozilla

I prefer MIT.

Ref: https://choosealicense.com/licenses/