- Boost - lists.preview.boost.org

Re: [boost] Help Boost, Please!
by David Sankel 25 Apr '23

25 Apr '23

On Mon, Apr 24, 2023 at 2:03 PM Louis Tatta via Boost <boost(a)lists.boost.org> wrote: > Issues can be opened against the documentation for anything at all by > pressing the “Report an Issue” button located at the top right of every > documentation page, or simply by visiting > https://github.com/cppalliance/site-docs/issues I added https://github.com/cppalliance/site-docs/issues/17 for *The 'Getting Started Doc' should use CMake as the primary way to build and use Boost.* I think one of the key areas to focus on is new user success. Whatever we can do to prevent folks from giving up when they attempt using Boost for the first time will have a substantial impact. -- David

1 0

Re: [boost] Help Boost, Please!
by Kostas Savvidis 24 Apr '23

24 Apr '23

> On Apr 24, 2023, at 21:03, Louis Tatta via Boost <boost(a)lists.boost.org> wrote: > > The more that people help out, the better the results will be. I just asked GPT-4 to do it! Of course, without too much context it produces nonsense, see below, but providing it with more detailed instructions and previously existing documentation on this and asking to change this and that can possibly do the job. Below the contributor guide I am posting an even more exotic "beginner's guide to asio". I suspect it might be complete nonsense too, but enjoy! Cheers, Kostas =============================================================================== Boost Library Contributor Guide Thank you for your interest in contributing to the Boost library collection. The following guide outlines the requirements and guidelines for submitting a library to Boost. Requirements To ensure a smooth submission process and avoid rejection, the library you submit must meet the following requirements: License requirements: The license must be simple to read and understand. The license must grant permission without fee to copy, use, and modify the software for any use (commercial and non-commercial). The license must require that the license appear on all copies of the software source code. The license must not require that the license appear with executables or other binary uses of the library. The license must not require that the source code be available for execution or other binary uses of the library. The license may restrict the use of the name and description of the library to the standard version found on the Boost website. Restricted licenses like the GPL and LGPL are not acceptable. Copyright ownership: The copyright ownership of the library must be clear. Include a copyright notice in all the important files you submit. Portability requirements: The library's interface must be portable and not restricted to a particular compiler or operating system. The library's implementation must, if possible, be portable and not restricted to a particular compiler or operating system. If a portable implementation is not possible, non-portable constructions are acceptable if reasonably easy to port to other environments. Implementations must be provided for at least two popular operating systems (such as UNIX and Windows). The library must run on at least two C++ compilers implementing the latest ISO C++ standard. Boost contributors often try to ensure their libraries work with popular compilers. Use the boost/config.hpp configuration header to work around compiler deficiencies. Organization requirements: The library must be generally useful. The library must adhere to the Boost standard library organization upon acceptance. The author must be willing to participate in discussions on the mailing list and refine the library accordingly. Guidelines To increase the chances of your library being accepted and to maintain consistency within the Boost library collection, follow these guidelines: Backwards compatibility: Provide a stable interface for your library, and avoid breaking changes unless absolutely necessary. If you must introduce breaking changes, provide a clear and easy migration path for users. Design and programming: Follow the C++ standard library conventions and idioms whenever possible. Avoid overly complex designs and keep the library simple and easy to use. Filenames: Use lowercase filenames, with words separated by underscores. Use the .hpp extension for header files, and the .cpp extension for implementation files. Naming consistency: Use consistent naming conventions for classes, functions, and other identifiers. Follow the Boost naming conventions as closely as possible. Documentation: Provide thorough and clear documentation for your library. Use Doxygen-style comments in your header files to document interfaces and functions. Provide examples and usage scenarios to demonstrate how to use your library. Rationale For a detailed explanation of the reasons behind these requirements and guidelines, refer to the Boost Library Requirements and Guidelines document. Acknowledgements We appreciate your contribution to the Boost library collection and thank you for following these requirements and guidelines. If you have any questions or concerns, please don't hesitate to ask for help on the Boost developers mailing list. ============================================================================================= could you write a new user guide for the boost.asio library? Sure, I can provide a beginner's guide to using the Boost.Asio library. Here it is: Boost.Asio is a library for network and low-level I/O programming in C++. It provides a set of abstractions for dealing with sockets, timers, and other I/O objects. Boost.Asio is designed to be portable across operating systems and platforms and is built on top of the Boost C++ libraries. To use Boost.Asio, you'll need to have the Boost libraries installed on your system. You can download the latest version of Boost from the Boost website, and follow the instructions for installation. Once you have Boost installed, you can include the Boost.Asio header file in your C++ code: cpp #include <boost/asio.hpp> This gives you access to the Boost.Asio library. Here's a basic example that demonstrates how to use Boost.Asio to create a TCP server that listens for incoming connections and sends a simple message to the client: cpp #include <iostream> #include <boost/asio.hpp> using boost::asio::ip::tcp; int main() { boost::asio::io_context io_context; tcp::acceptor acceptor(io_context, tcp::endpoint(tcp::v4(), 8888)); while (true) { tcp::socket socket(io_context); acceptor.accept(socket); std::string message = "Hello, World!"; boost::system::error_code error; boost::asio::write(socket, boost::asio::buffer(message), error); } return 0; } In this example, we create an io_context object, which is the central object that drives the Boost.Asio library. We then create a tcp::acceptor object, which listens for incoming TCP connections on port 8888. Inside the while loop, we accept incoming connections using the acceptor.accept() method, which blocks until a new connection is established. We then create a new tcp::socket object to handle the communication with the client. Finally, we send a simple message to the client using the boost::asio::write() method, which writes the message to the socket. This is just a basic example, but Boost.Asio provides a wide range of abstractions for handling network and low-level I/O programming in C++. You can find more information in the Boost.Asio documentation. Here are a few tips for using Boost.Asio: Use asynchronous I/O operations whenever possible. This can help you avoid blocking and maximize the throughput of your application. Use the io_context object to manage the lifecycle of your I/O objects, such as sockets and timers. Use the deadline_timer object to schedule timeouts for I/O operations. Use the streambuf object to handle variable-length data, such as incoming messages over a socket. Be aware of thread safety issues when using Boost.Asio in a multi-threaded environment. The library provides a number of synchronization primitives, such as mutexes and condition variables, to help you manage concurrency. With a little practice, you should be able to use Boost.Asio to build complex network and low-level I/O applications in C++. Good luck! > _______________________________________________ > Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost

1 0

Re: [boost] Help Boost, Please!
by Vinnie Falco 24 Apr '23

24 Apr '23

On Mon, Apr 24, 2023 at 11:03 AM Louis Tatta via Boost <boost(a)lists.boost.org> wrote: > Issues can be opened against the documentation for anything at all by > pressing the “Report an Issue” button located at the top right of every > documentation page, or simply by visiting > https://github.com/cppalliance/site-docs/issues In case this wasn't clear - if YOU (the person reading this) want to have ANYTHING changed or added in the site documentation, all you need to do is open an issue and it will be triaged and attended to: https://github.com/cppalliance/site-docs/issues Thanks

1 0

Re: [boost] Help Boost, Please!
by Ruben Perez 24 Apr '23

24 Apr '23

> Peter Turcan is a new face at The C++ Alliance but a veteran at Technical > Writing. He needs your help to make these pages shine. Specifically, we > need volunteers for the following: > > Check the documentation for accuracy > Make suggestions for improvements or changes > Contribute directly to the documentation (pull requests VERY welcomed) > Review pull requests that are awaiting merge > Report problems with links or styling > I'm happy to help. Ruben.

1 0

Help Boost, Please!
by Louis Tatta 24 Apr '23

24 Apr '23

To improve Boost we are writing new documentation for the website, divided into four documentation projects: User’s Guide https://docs.cppalliance.org/doc/user-guide/ Contributor’s Guide https://docs.cppalliance.org/doc/contributor-guide/ Formal Review Manual: https://docs.cppalliance.org/doc/formal-reviews/ Release Process Book https://docs.cppalliance.org/doc/release-process/ (“develop” branch versions of these docs can be viewed at the corresponding https://stage.docs.cppaliance.org URL). The source code repository for the documentation is located here and will be moved to the Boost organization after final approval: https://github.com/cppalliance/site-docs Peter Turcan is a new face at The C++ Alliance but a veteran at Technical Writing. He needs your help to make these pages shine. Specifically, we need volunteers for the following: Check the documentation for accuracy Make suggestions for improvements or changes Contribute directly to the documentation (pull requests VERY welcomed) Review pull requests that are awaiting merge Report problems with links or styling Issues can be opened against the documentation for anything at all by pressing the “Report an Issue” button located at the top right of every documentation page, or simply by visiting https://github.com/cppalliance/site-docs/issues The more that people help out, the better the results will be. Note that the current stylesheets for these documentation pages are using the “Antora default UI” but before this goes on to https://www.boost.org it will be restyled to match the look and feel of the site. If you wish to help out please respond to this message on-list so that others know you are pitching it, that we might get a snowball effect. Best Regards, Louis Tatta The C++ Alliance

1 0

Re: [boost] multiprecision issues
by John Maddock 23 Apr '23

23 Apr '23

On 22/04/2023 22:48, Gero Peterhoff via Boost wrote: > Hi John, > i stumbled over some more issues https://godbolt.org/z/x5srG9eof : > - the unary operator- does not work with > boost::multiprecision::cpp_bin_float_N on nan > - operator<<(boost::multiprecision::float128) does not support > std::showpos with std::hexfloat > - operator<<(boost::multiprecision::cpp_bin_float_N) does not support > std::hexfloat and in the case of nan does not support std::showpos > > I also miss C++17 from_chars/to_chars. > I realize that this is extremely tedious work, but multiprecision > should be as compatible to the standard as possible. > If you want, I'll be happy to look for various issues and report them > to you, but you'll have to fix them yourself. Can you please report these as separate issues on github (https://github.com/boostorg/multiprecision/issues) so we have something to track? Thanks! John.

1 0

multiprecision issues
by Gero Peterhoff 22 Apr '23

22 Apr '23

Hi John, i stumbled over some more issues https://godbolt.org/z/x5srG9eof : - the unary operator- does not work with boost::multiprecision::cpp_bin_float_N on nan - operator<<(boost::multiprecision::float128) does not support std::showpos with std::hexfloat - operator<<(boost::multiprecision::cpp_bin_float_N) does not support std::hexfloat and in the case of nan does not support std::showpos I also miss C++17 from_chars/to_chars. I realize that this is extremely tedious work, but multiprecision should be as compatible to the standard as possible. If you want, I'll be happy to look for various issues and report them to you, but you'll have to fix them yourself. cu Gero

1 0

Re: [boost] ccmath::copysign/signbit
by Matt Borland 22 Apr '23

22 Apr '23

Gero, > 1) copysign uses abs, which is wrong. copysign/signbit may *only* change/check the sign (https://en.cppreference.com/w/cpp/numeric/math/copysign https://en.cppreference.com/w/cpp/numeric/math/signbit) I think you are conflating signbit and copysign here. Copysign is to return the magnitude of the first argument (which by definition is the absolute value) with the sign of the second argument. We use signbit in the implementation of this because copysign can be used to manipulate the signs of NaNs. > 2) In signbit.hpp you implement struct IEEEfN2bits. But these are incomplete: > - long double can be 16/12/10 bytes depending on platform/compiler option. You do not take this into account. > - Correct types are already available in boost/math/cstdfloat/cstdfloat_types.hpp. You will find implementations of IEEEl2bits here https://github.com/boostorg/math/blob/develop/include/boost/math/ccmath/sig…. They account for 64, 80, and 128 bit long doubles based on LDBL_MANT_DIG and LDBL_MAX_EXP. If for instance you use compiler flags on GCC to alter the size of a long double those macros are changed accordingly. > PS > gcc13 is about to be released (https://gcc.gnu.org) so it is high time to support std::floatN_t as well. Yes, the release of GCC 13 is scheduled for next week. Once it’s available for download I will open issues/PRs to fix any breakages that come from the new types. In the interim I believe, but cannot confirm that if you use a policy that disables promotion you should be fine. Matt

2 1

Re: [boost] ccmath implementations
by John Maddock 21 Apr '23

21 Apr '23

On 21/04/2023 15:05, Gero Peterhoff via Boost wrote: > Hi Matt, > the ccmath functions must/could only work with std types. Is this > assumption correct? > The constexpr code path is almost certainly for std types only. However, they can be used in generic functions declared constexpr, which are not necessarily used in a constexpr context: in that case the argument could be any suitable type. John.

1 0

ccmath::copysign/signbit
by Gero Peterhoff 20 Apr '23

20 Apr '23

Hi Matt, I see the following problems in your implementations for ccmath::copysign/signbit: 1) copysign uses abs, which is wrong. copysign/signbit may *only* change/check the sign (https://en.cppreference.com/w/cpp/numeric/math/copysign https://en.cppreference.com/w/cpp/numeric/math/signbit) 2) In signbit.hpp you implement struct IEEEfN2bits. But these are incomplete: - long double can be 16/12/10 bytes depending on platform/compiler option. You do not take this into account. - Correct types are already available in boost/math/cstdfloat/cstdfloat_types.hpp. Therefore, I provide the complete structures in ccmath/bits.hpp. This also contains structures for std::(b)float16_t and can be extended if needed. Extended type-traits for floats To minimize completely sprawling manual checks (#if + std::is_same) I provide more advanced TTs in type_traits/is_floating_point_more.hpp. This way ccmath::copysign/signbit can be implemented correctly. Possibly other functions are affected. thx Gero PS gcc13 is about to be released (https://gcc.gnu.org) so it is high time to support std::floatN_t as well.

1 0