Skip to content

Commit

Permalink
Minor fixups to README
Browse files Browse the repository at this point in the history
  • Loading branch information
@rollbear
rollbear committed Jan 27, 2025
1 parent 81220d0 commit 2b24a03
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
# <A name="modifiers"/> Modifiers:
* <A name="affine_point"/>`strong::affine_point<D>` allows instances to be
* <A name="affine_point"/>`strong::affine_point<D>` allows instances to be
subtracted (yielding a `D`) or to add or subtract a `D` to an instance.
See [Affine Space](https://en.wikipedia.org/wiki/Affine_space). Examples of
one dimentional affine points are pointer (with `D` being `ptrdiff_t`,) or
Expand Down Expand Up @@ -197,7 +197,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
* <A name="incrementable"/>`strong::incrementable`. Provides
[`operator++](https://en.cppreference.com/w/cpp/language/operator_incdec) for
[`operator++`](https://en.cppreference.com/w/cpp/language/operator_incdec) for
the strong type, using the operator of the underlying type.
Available in `strong_type/incrementable.hpp`
Expand Down Expand Up @@ -245,14 +245,14 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
Available in `strong_type/iterator.hpp`
* <A name="ordered"/>`strong::ordered` provides operators '<', '<=', '>=' and
'>'. The strong type offers the same ordering relatin as the underlying type.
* <A name="ordered"/>`strong::ordered` provides operators `<`, `<=`, `>=` and
`>`. The strong type offers the same ordering relation as the underlying type.
Available in `strong_type/ordered.hpp`
* <A name="ordered_with"/>`strong::ordered_with<Ts...>` provides operators '<',
'<=', '>=' and '>' between the strong type and each of the types `Ts...`.
* <A name="ordered_with"/>`strong::ordered_with<Ts...>` provides operators `<`,
`<=`, `>=` and `>` between the strong type and each of the types `Ts...`.
Note! While `Ts` can include other strong types, it cannot refer to the strong
type being defined. Use [`strong::ordered`](#ordered) for that.
Expand All @@ -268,15 +268,15 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
* <A name="partially_ordered"/>`strong::partially_ordered` provides operator
'<=>' The strong type offers the same ordering relatin as the underlying type.
`<=>` The strong type offers the same ordering relation as the underlying type.
The result is [`std::partial_ordering`](https://en.cppreference.com/w/cpp/utility/compare/partial_ordering).
Note! This does not imply [´strong::equality´](#equality).
Available in `strong_type/ordered.hpp`
* <A name="partially_ordered_with"/>`strong::partially_ordered_with<Ts...>`
provides operator '<=>' between the strong type and each of the types `Ts...`.
provides operator `<=>` between the strong type and each of the types `Ts...`.
Note! While `Ts` can include other strong types, it cannot refer to the strong
type being defined. Use [`strong::partially_ordered`](#partially_ordered) for
that. The result is [`std::partial_ordering`](https://en.cppreference.com/w/cpp/utility/compare/partial_ordering).
Expand All @@ -301,8 +301,8 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
Available in `strong_type/range.hpp`
* <A name="regular"/>`strong::regular`. Same as [`semiregular`](#semiregular)
and also equality comparable. A good default base for most types.
* <A name="regular"/>`strong::regular`. Same as [`strong::semiregular`](#semiregular)
and [`strong::equality`](#equality). A good default base for most types.
Available in `strong_type/regular.hpp`
Expand All @@ -315,14 +315,15 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
Available in `strong_type/scalable_with.hpp`
* <A name="semiregular"/>`strong::semiregular`. This gives you default
constructible, move/copy constructible, move/copy assignable and swappable.
* <A name="semiregular"/>`strong::semiregular`. This gives you
[`strong::default_constructible`](#default_constructible)
move/copy constructible, move/copy assignable and swappable.
A decent default for many types.
Available in `strong_type/semiregular.hpp`.
* <A name="strongly_ordered"/>`strong::strongly_ordered` provides operator '<=>'
* <A name="strongly_ordered"/>`strong::strongly_ordered` provides operator `<=>`
The strong type offers the same ordering relatin as the underlying type. The
result is [`std::strong_ordering`](https://en.cppreference.com/w/cpp/utility/compare/strong_ordering).
Note! This does not imply [´strong::equality<Ts...>´](#equality).
Expand All @@ -331,7 +332,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
* <A name="strongly_ordered_with"/>`strong::strongly_ordered_with<Ts...>`
provides operator '<=>' between the strong type and each of the types `Ts...`.
provides operator `<=>` between the strong type and each of the types `Ts...`.
Note! While `Ts` can include other strong types, it cannot refer to the strong
type being defined. Use [`strong::strongly_ordered`](#strongly_ordered) for
that. The result is [`std::strong_ordering`](https://en.cppreference.com/w/cpp/utility/compare/strong_ordering)
Expand All @@ -345,7 +346,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
Available in `strong_type/unique.hpp`
* <A name="weakly_ordered"/>`strong::weakly_ordered` provides operator '<=>'
* <A name="weakly_ordered"/>`strong::weakly_ordered` provides operator `<=>`
The strong type offers the same ordering relatin as the underlying type. The
result is [`std::weak_ordering`](https://en.cppreference.com/w/cpp/utility/compare/weak_ordering).
Note! This does not imply [´strong::equality´](#equality).
Expand All @@ -354,7 +355,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
* <A name="weakly_ordered_with"/>`strong::weakly_ordered_with<Ts...>` provides
operator '<=>' between the strong type and each of the types `Ts...`.
operator `<=>` between the strong type and each of the types `Ts...`.
Note! While `Ts` can include other strong types, it cannot refer to the strong
type being defined. Use [`strong::weakly_ordered`](#weakly_ordered) for
that. The result is [`std::weak_ordering`](https://en.cppreference.com/w/cpp/utility/compare/weak_ordering)
Expand All @@ -369,7 +370,8 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
A number of small utilities are available directly in `strong_type/type.hpp`.
* `strong::type` provides a non-member `swap()` function as a friend, which
swaps underlying values using.
swaps underlying values using [`std::swap`](https://en.cppreference.com/w/cpp/algorithm/swap)
or a specific swap function for the underlying type.
* `strong::underlying_type<Type>` is `T` for `strong::type<T, Tag, Ms...>` and
Expand Down Expand Up @@ -714,4 +716,4 @@ correctly. Those found to cause trouble are disabled for those versions.

Discussions, pull-requests, flames are welcome.

[@bjorn_fahller](https://twitter.com/bjorn_fahller)
[https://fosstodon.org/@rollbear](https://fosstodon.org/@rollbear), [@rollbear.bsky.social](https://bsky.app/profile/rollbear.bsky.social)

0 comments on commit 2b24a03

Please sign in to comment.