[libc++][ranges] Add ranges::in_out_out_result

[philnik]

Summary

Add ranges::in_out_out_result

[philnik]

• Add no_unique_address test

[Mordante]

LGTM modulo some nits.

libcxx/test/std/algorithms/algorithms.results/in_out_out_result.pass.cpp

15

copy-paste.

79

Why do you use 10L when you want an int?

[philnik]

• Address comments

[• Quuxplusone]

LGTM % comments!

libcxx/test/std/algorithms/algorithms.results/in_in_out_result.pass.cpp

15

I believe you changed the copy-paste error in the wrong (original) file! Please undo it here, and do it there.

libcxx/test/std/algorithms/algorithms.results/in_out_out_result.pass.cpp

79

This, also, was fixed in the original file. (Please keep it fixed there, but also fix it here.)

libcxx/include/CMakeLists.txt

set(files
   __algorithm/find_if_not.h
   __algorithm/for_each.h
   __algorithm/for_each_n.h
   __algorithm/generate.h
   __algorithm/generate_n.h
   __algorithm/half_positive.h
   __algorithm/in_in_out_result.h
   __algorithm/in_in_result.h
+  __algorithm/in_out_out_result.h
   __algorithm/in_out_result.h
   __algorithm/includes.h
   __algorithm/inplace_merge.h
   __algorithm/is_heap.h
   __algorithm/is_heap_until.h
   __algorithm/is_partitioned.h
   __algorithm/is_permutation.h
   __algorithm/is_sorted.h

libcxx/include/__algorithm/in_out_out_result.h

+// -*- C++ -*-
+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef _LIBCPP___ALGORITHM_IN_OUT_OUT_RESULT_H
+#define _LIBCPP___ALGORITHM_IN_OUT_OUT_RESULT_H
+
+#include <__concepts/convertible_to.h>
+#include <__config>
+#include <__utility/move.h>
+
+_LIBCPP_BEGIN_NAMESPACE_STD
+
+#ifndef _LIBCPP_HAS_NO_CONCEPTS
+
+namespace ranges {
+template <class _I1, class _O1, class _O2>
+struct in_out_out_result {
+  [[no_unique_address]] _I1 in;
+  [[no_unique_address]] _O1 out1;
+  [[no_unique_address]] _O2 out2;
+
+  template <class _II1, class _OO1, class _OO2>
+    requires convertible_to<const _I1&, _II1> && convertible_to<const _O1&, _OO1> && convertible_to<const _O2&, _OO2>
+  _LIBCPP_HIDE_FROM_ABI constexpr
+  operator in_out_out_result<_II1, _OO1, _OO2>() const& {
+    return {in, out1, out2};
+  }
+
+  template <class _II1, class _OO1, class _OO2>
+    requires convertible_to<_I1, _II1> && convertible_to<_O1, _OO1> && convertible_to<_O2, _OO2>
+  _LIBCPP_HIDE_FROM_ABI constexpr
+  operator in_out_out_result<_II1, _OO1, _OO2>() && {
+    return {_VSTD::move(in), _VSTD::move(out1), _VSTD::move(out2)};
+  }
+};
+} // namespace ranges
+
+#endif // _LIBCPP_HAS_NO_CONCEPTS
+
+_LIBCPP_END_NAMESPACE_STD
+
+#endif // _LIBCPP___ALGORITHM_IN_OUT_OUT_RESULT_H

libcxx/include/algorithm

 {
 
 namespace ranges {
   template <class I1, class I2>
     struct in_in_result;     // since C++20
 
   template <class I1, class I2, class O>
     struct in_in_out_result; // since C++20
+
+  template <class I, class O1, class O2>
+    struct in_out_out_result; // since C++20
 }
 
 template <class InputIterator, class Predicate>
     constexpr bool     // constexpr in C++20
     all_of(InputIterator first, InputIterator last, Predicate pred);
 
 template <class InputIterator, class Predicate>
     constexpr bool     // constexpr in C++20

 #include <__algorithm/find_if_not.h>
 #include <__algorithm/for_each.h>
 #include <__algorithm/for_each_n.h>
 #include <__algorithm/generate.h>
 #include <__algorithm/generate_n.h>
 #include <__algorithm/half_positive.h>
 #include <__algorithm/in_in_out_result.h>
 #include <__algorithm/in_in_result.h>
+#include <__algorithm/in_out_out_result.h>
 #include <__algorithm/in_out_result.h>
 #include <__algorithm/includes.h>
 #include <__algorithm/inplace_merge.h>
 #include <__algorithm/is_heap.h>
 #include <__algorithm/is_heap_until.h>
 #include <__algorithm/is_partitioned.h>
 #include <__algorithm/is_permutation.h>
 #include <__algorithm/is_sorted.h>

libcxx/include/module.modulemap

module __algorithm {
       module find_if_not              { private header "__algorithm/find_if_not.h" }
       module for_each                 { private header "__algorithm/for_each.h" }
       module for_each_n               { private header "__algorithm/for_each_n.h" }
       module generate                 { private header "__algorithm/generate.h" }
       module generate_n               { private header "__algorithm/generate_n.h" }
       module half_positive            { private header "__algorithm/half_positive.h" }
       module in_in_out_result         { private header "__algorithm/in_in_out_result.h" }
       module in_in_result             { private header "__algorithm/in_in_result.h" }
+      module in_out_out_result        { private header "__algorithm/in_out_out_result.h" }
       module in_out_result            { private header "__algorithm/in_out_result.h" }
       module includes                 { private header "__algorithm/includes.h" }
       module inplace_merge            { private header "__algorithm/inplace_merge.h" }
       module is_heap                  { private header "__algorithm/is_heap.h" }
       module is_heap_until            { private header "__algorithm/is_heap_until.h" }
       module is_partitioned           { private header "__algorithm/is_partitioned.h" }
       module is_permutation           { private header "__algorithm/is_permutation.h" }
       module is_sorted                { private header "__algorithm/is_sorted.h" }

libcxx/test/libcxx/diagnostics/detail.headers/algorithm/in_out_out_result.module.verify.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// REQUIRES: modules-build
+
+// WARNING: This test was generated by 'generate_private_header_tests.py'
+// and should not be edited manually.
+
+// expected-error@*:* {{use of private header from outside its module: '__algorithm/in_out_out_result.h'}}
+#include <__algorithm/in_out_out_result.h>

libcxx/test/std/algorithms/algorithms.results/in_in_out_result.pass.cpp

 //===----------------------------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 // UNSUPPORTED: c++03, c++11, c++14, c++17
 // UNSUPPORTED: libcpp-no-concepts
 // UNSUPPORTED: libcpp-has-no-incomplete-ranges
 
 // template <class I1, class I2, class O>
 // struct in_in_out_result;
 
 #include <algorithm>
 #include <cassert>
 #include <type_traits>
 
 #include "MoveOnly.h"
 
 template <class T>
 struct ConvertibleFrom {

 static_assert(std::is_move_constructible_v<std::ranges::in_in_out_result<int, int, MoveOnly>>);
 
 static_assert(!std::is_copy_constructible_v<std::ranges::in_in_out_result<MoveOnly, int, int>>);
 static_assert(!std::is_copy_constructible_v<std::ranges::in_in_out_result<int, MoveOnly, int>>);
 static_assert(!std::is_copy_constructible_v<std::ranges::in_in_out_result<int, int, MoveOnly>>);
 
 constexpr bool test() {
   {
-    std::ranges::in_in_out_result<int, double, float> res{10L, 0., 1.f};
+    std::ranges::in_in_out_result<int, double, float> res{10, 0., 1.f};
     assert(res.in1 == 10);
     assert(res.in2 == 0.);
     assert(res.out == 1.f);
     std::ranges::in_in_out_result<ConvertibleFrom<int>, ConvertibleFrom<double>, ConvertibleFrom<float>> res2 = res;
     assert(res2.in1.content == 10);
     assert(res2.in2.content == 0.);
     assert(res2.out.content == 1.f);
   }

libcxx/test/std/algorithms/algorithms.results/in_out_out_result.pass.cpp

+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// UNSUPPORTED: c++03, c++11, c++14, c++17
+// UNSUPPORTED: libcpp-no-concepts
+// UNSUPPORTED: libcpp-has-no-incomplete-ranges
+
+// template <class I1, class O1, class O2>
+// struct in_out_out_result;
+
+#include <algorithm>
+#include <cassert>
+#include <type_traits>
+
+#include "MoveOnly.h"
+
+template <class T>
+struct ConvertibleFrom {
+  constexpr ConvertibleFrom(T c) : content{c} {}
+  T content;
+};
+
+struct A {
+  explicit A(int);
+};
+// conversion is not implicit
+static_assert(!std::is_constructible_v<std::ranges::in_out_out_result<A, A, A>,
+                                       std::ranges::in_out_out_result<int, int, int>>);
+
+struct B {
+  B(int);
+};
+static_assert(std::is_constructible_v<std::ranges::in_out_out_result<B, B, B>, std::ranges::in_out_out_result<int, int, int>>);
+static_assert(std::is_constructible_v<std::ranges::in_out_out_result<B, B, B>, std::ranges::in_out_out_result<int, int, int>&>);
+static_assert(std::is_constructible_v<std::ranges::in_out_out_result<B, B, B>, const std::ranges::in_out_out_result<int, int, int>>);
+static_assert(std::is_constructible_v<std::ranges::in_out_out_result<B, B, B>, const std::ranges::in_out_out_result<int, int, int>&>);
+
+struct C {
+  C(int&);
+};
+static_assert(!std::is_constructible_v<std::ranges::in_out_out_result<C, C, C>, std::ranges::in_out_out_result<int, int, int>&>);
+
+static_assert(std::is_convertible_v<std::ranges::in_out_out_result<int, int, int>&,
+                                    std::ranges::in_out_out_result<long, long, long>>);
+static_assert(std::is_convertible_v<const std::ranges::in_out_out_result<int, int, int>&,
+                                    std::ranges::in_out_out_result<long, long, long>>);
+static_assert(std::is_convertible_v<std::ranges::in_out_out_result<int, int, int>&&,
+                                    std::ranges::in_out_out_result<long, long, long>>);
+static_assert(std::is_convertible_v<const std::ranges::in_out_out_result<int, int, int>&&,
+                                    std::ranges::in_out_out_result<long, long, long>>);
+
+struct NotConvertible {};
+static_assert(!std::is_convertible_v<std::ranges::in_out_out_result<NotConvertible, int, int>,
+                                     std::ranges::in_out_out_result<int, int, int>>);
+static_assert(!std::is_convertible_v<std::ranges::in_out_out_result<int, NotConvertible, int>,
+                                     std::ranges::in_out_out_result<int, int, int>>);
+static_assert(!std::is_convertible_v<std::ranges::in_out_out_result<int, int, NotConvertible>,
+                                     std::ranges::in_out_out_result<int, int, int>>);
+
+static_assert(std::is_constructible_v<std::ranges::in_out_out_result<MoveOnly, MoveOnly, MoveOnly>,
+                                      std::ranges::in_out_out_result<int, int, int>&>);
+
+static_assert(std::is_move_constructible_v<std::ranges::in_out_out_result<MoveOnly, int, int>>);
+static_assert(std::is_move_constructible_v<std::ranges::in_out_out_result<int, MoveOnly, int>>);
+static_assert(std::is_move_constructible_v<std::ranges::in_out_out_result<int, int, MoveOnly>>);
+
+static_assert(!std::is_copy_constructible_v<std::ranges::in_out_out_result<MoveOnly, int, int>>);
+static_assert(!std::is_copy_constructible_v<std::ranges::in_out_out_result<int, MoveOnly, int>>);
+static_assert(!std::is_copy_constructible_v<std::ranges::in_out_out_result<int, int, MoveOnly>>);
+
+constexpr bool test() {
+  {
+    std::ranges::in_out_out_result<int, double, float> res{10, 0., 1.f};
+    assert(res.in == 10);
+    assert(res.out1 == 0.);
+    assert(res.out2 == 1.f);
+    std::ranges::in_out_out_result<ConvertibleFrom<int>, ConvertibleFrom<double>, ConvertibleFrom<float>> res2 = res;
+    assert(res2.in.content == 10);
+    assert(res2.out1.content == 0.);
+    assert(res2.out2.content == 1.f);
+  }
+  {
+    std::ranges::in_out_out_result<MoveOnly, int, int> res1{MoveOnly{}, 0, 0};
+    assert(res1.in.get() == 1);
+    auto res2 = static_cast<std::ranges::in_out_out_result<MoveOnly, int, int>>(std::move(res1));
+    assert(res1.in.get() == 0);
+    assert(res2.in.get() == 1);
+  }
+  {
+    auto [in, out1, out2] = std::ranges::in_out_out_result<int, int, int>{1, 2, 3};
+    assert(in == 1);
+    assert(out1 == 2);
+    assert(out2 == 3);
+  }
+  return true;
+}
+
+int main(int, char**) {
+  test();
+  static_assert(test());
+
+  return 0;
+}

libcxx/test/std/algorithms/algorithms.results/no_unique_address.compile.pass.cpp

 static_assert(sizeof(std::ranges::in_in_out_result<Empty, int, int>) == 2 * sizeof(int));
 static_assert(sizeof(std::ranges::in_in_out_result<int, Empty, int>) == 2 * sizeof(int));
 static_assert(sizeof(std::ranges::in_in_out_result<int, int, Empty>) == 2 * sizeof(int));
 static_assert(sizeof(std::ranges::in_in_out_result<char, Empty, Empty>) == 2);
 static_assert(sizeof(std::ranges::in_in_out_result<Empty, char, Empty>) == 2);
 static_assert(sizeof(std::ranges::in_in_out_result<Empty, Empty, char>) == 2);
 static_assert(sizeof(std::ranges::in_in_out_result<int, Empty, Empty2>) == sizeof(int));
 static_assert(sizeof(std::ranges::in_in_out_result<Empty, Empty, Empty>) == 3);
+
+static_assert(sizeof(std::ranges::in_out_out_result<Empty, int, int>) == 2 * sizeof(int));
+static_assert(sizeof(std::ranges::in_out_out_result<int, Empty, int>) == 2 * sizeof(int));
+static_assert(sizeof(std::ranges::in_out_out_result<int, int, Empty>) == 2 * sizeof(int));
+static_assert(sizeof(std::ranges::in_out_out_result<char, Empty, Empty>) == 2);
+static_assert(sizeof(std::ranges::in_out_out_result<Empty, char, Empty>) == 2);
+static_assert(sizeof(std::ranges::in_out_out_result<Empty, Empty, char>) == 2);
+static_assert(sizeof(std::ranges::in_out_out_result<int, Empty, Empty2>) == sizeof(int));
+static_assert(sizeof(std::ranges::in_out_out_result<Empty, Empty, Empty>) == 3);