Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add libcpp multimap and unordered_multimap #4419

Merged
merged 1 commit into from
Oct 22, 2021

Conversation

Dobatymo
Copy link
Contributor

These two containers are still missing from libcpp.

@Dobatymo Dobatymo force-pushed the add-cpp-multimap branch 2 times, most recently from d6448a9 to dd855cc Compare October 18, 2021 09:43
@scoder
Copy link
Contributor

scoder commented Oct 20, 2021

Thanks. Could you please make sure that all methods that can raise C++ exceptions are marked with except +?

@Dobatymo
Copy link
Contributor Author

Dobatymo commented Oct 20, 2021

@scoder I think I got all of them. Usually the constructor, insert and at methods can throw exceptions. Since there are not at methods on multisets, it's only the first two.

Because the methods have the correct types, it actually leads to some issues, because iterator cannot be converted to const_iterator automatically.
so multimap.insert(multimap.begin(), multimap.end()) doesn't work, although it shouldn't be a problem in pure C++. I don't know if that's a Cython issue, or if something needs to be improved with the definition of the Iterator classes (for other containers as well).

See my comment here as well #4410 (comment)

@da-woods
Copy link
Contributor

Because the methods have the correct types, it actually leads to some issues, because iterator cannot be converted to const_iterator automatically.
so multimap.insert(multimap.begin(), multimap.end()) doesn't work, although it shouldn't be a problem in pure C++. I don't know if that's a Cython issue, or if something needs to be improved with the definition of the Iterator classes (for other containers as well).

I think this may be because Cython insists of specifying all the template arguments (so it generates code like multimap.insert<std::multimap<...>::iterator>(multimap.begin(), multimap.end()). It'd be nice to have some way to override that because it causes problems all over the place. It's not entirely trivial because Cython still needs to understand the template arguments for the return type though.

The best thing for the moment is just to omit the methods until we have a good solution.

@Dobatymo
Copy link
Contributor Author

Dobatymo commented Oct 21, 2021

Actually my previous comment is slightly wrong. insert does work, it uses the templated type correctly. erase didn't work because that required the implicit conversion from iterator to const_iterator.
But that can actually be fixed if the conversion is done explicitly (although in pure c++ it would happen implicitly).

cdef multimap[int, int] m = multimap[int, int]()
m.erase(multimap[int, int].const_iterator(m.begin()), multimap[int, int].const_iterator(m.end()))

compiles fine.

@scoder
Copy link
Contributor

scoder commented Oct 22, 2021

@scoder I think I got all of them. Usually the constructor, insert and at methods can throw exceptions. Since there are not at methods on multisets, it's only the first two.

Basically anything that does memory allocation can fail with a C++ exception. I would guess that the iterator constructors also do that.

@da-woods
Copy link
Contributor

Basically anything that does memory allocation can fail with a C++ exception. I would guess that the iterator constructors also do that.

I can't find a definitive reference for all the iterator constructors, but that begin and end look to be noexcept and they return iterators, it must be possible to construct an iterator without risking an exception.

@scoder
Copy link
Contributor

scoder commented Oct 22, 2021

I can't find a definitive reference for all the iterator constructors, but that begin and end look to be noexcept and they return iterators, it must be possible to construct an iterator without risking an exception.

I was more thinking of constructors like const_iterator(iterator). Or are those just some kind of cast?

@da-woods
Copy link
Contributor

I was more thinking of constructors like const_iterator(iterator). Or are those just some kind of cast?

So the copy constructor and copy assignment (iterator to iterator) is explicitly safe (as a reference, section E.4.4 https://www.stroustrup.com/3rd_safe.pdf). I'm not sure if iterator to const_iterator is explicitly included in that, but I don't see why it'd need to throw an exception if you can copy without needing to, and construct a new iterator in begin without needing to.

@scoder
Copy link
Contributor

scoder commented Oct 22, 2021

Ok, I guess we're safe then. Everything else seems to be returning by reference or by value.

@scoder scoder merged commit f776da0 into cython:master Oct 22, 2021
@scoder
Copy link
Contributor

scoder commented Oct 22, 2021

Thanks

@Dobatymo Dobatymo deleted the add-cpp-multimap branch October 25, 2021 03:00
0dminnimda added a commit to 0dminnimda/cython that referenced this pull request Oct 26, 2021
commit 1461e51
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Mon Oct 25 14:29:02 2021 +0200

    Clean up the NumPy integration test by moving the doctests into the functions that they test.

commit 68bb716
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Mon Oct 25 14:14:24 2021 +0200

    Remove dead test code.

commit 4a74678
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Sun Oct 24 21:27:44 2021 +0200

    Use newer test dependencies in Py3.6+. (Excluding 3.10 for now to give the projects a bit more time.)

commit 9d1ffd5
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Sun Oct 24 23:13:50 2021 +0100

    Initial support for Python 3.11 (cythonGH-4414)

    * Add a basic replacement for PyCode_New().

    An optimized versions would be nice, but this is intended to work sufficiently to start testing. Also, CPython 3.11 might actually add a new C-API function to simplify setting the current code position. That might be used instead.

    * Disable introspection of frame object with vectorcall

    This feature looked to only be used for early Python versions that don't have the full vectorcall protocol (and the contents of the frame object are changed in Python 3.11).

commit 346c81f
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Sun Oct 24 21:18:10 2021 +0200

    Make sure that version dependent special methods are correctly and completely excluded via preprocessor guards.
    Previously, implementing "__div__" could fail in Py3 (if the code for adapting the Python wrapper was generated) or would at least generate C compiler warnings about unused "__div__" C functions.

commit 3748c3c
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Sun Oct 24 13:22:34 2021 +0200

    Add Py3.10 as CI test target.

commit 0f84a57
Author: Max Bachmann <kontakt@maxbachmann.de>
Date:   Sat Oct 23 22:06:37 2021 +0200

    Update incorrect version support comment for pycapsule.pxd (cythonGH-4426)

commit c25c87d
Author: Dobatymo <Dobatymo@users.noreply.github.com>
Date:   Sat Oct 23 03:33:02 2021 +0800

    Fix libcpp map/set/multiset/unordered type issues (cythonGH-4410)

    Fix insert return types, constness and input iterator templates.
    Fix typing in iterators and add constructor to allow explicit conversion from iterator to const_iterator.

commit f776da0
Author: Dobatymo <Dobatymo@users.noreply.github.com>
Date:   Sat Oct 23 03:28:53 2021 +0800

    Add C++ multimap/unordered_multimap (cythonGH-4419)

commit c83fd44
Author: 0dminnimda <0dminnimda@gmail.com>
Date:   Fri Oct 22 21:44:11 2021 +0300

    Introduce new shell syntax for ci-run.sh to improve Windows support (cythonGH-4400)

commit c8c9a12
Merge: 174ca03 f53ac52
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Thu Oct 21 19:02:11 2021 +0200

    Merge branch '0.29.x'

commit f53ac52
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Tue May 25 11:20:54 2021 +0200

    docs: Use the Cython + IPython lexers that come with Pygments to avoid having to maintain our own ones.

commit 174ca03
Author: account-login <account-login@users.noreply.github.com>
Date:   Wed Oct 20 17:03:20 2021 +0800

    Add some missing functions to libcpp maps and string (cythonGH-4395)

    * add swap() to libcpp.string
    * add load_factor() to libcpp.unordered_map and libcpp.unordered_set

commit 42a4af2
Merge: 53b0eb2 fb5d29e
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Mon Oct 18 20:38:22 2021 +0200

    Merge branch '0.29.x'

commit fb5d29e
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Mon Oct 18 19:36:54 2021 +0100

    Fix tracing after adapting it to Py3.11 (cythonGH-4420)

commit 53b0eb2
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Mon Oct 18 19:36:54 2021 +0100

    Fix tracing after adapting it to Py3.11 (cythonGH-4420)

commit 5f820ed
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Mon Oct 18 11:10:05 2021 +0100

    Fix fused.__self__ tests on PyPy (cythonGH-4417)

    PyPy v7.3.6 looks to have added a helpful "did you mean..." to the AttributeError exception. It's currently tripping up these tests.

commit 4df1103
Merge: f6eeeda cbddad2
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Mon Oct 18 12:05:10 2021 +0200

    Merge branch '0.29.x'

commit cbddad2
Author: Victor Stinner <vstinner@python.org>
Date:   Mon Oct 18 12:03:17 2021 +0200

    Make Profile.c use PyThreadState_EnterTracing() (cythonGH-4411)

    Instead of __Pyx_SetTracing(), Profile.c now uses PyThreadState_EnterTracing() and PyThreadState_LeaveTracing(), which were added to Python 3.11.0a2:
    python/cpython#28542

    When these functions are used, Cython no longer sets directly PyThreadState.cframe.use_tracing.

commit f6eeeda
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Sun Oct 17 19:01:52 2021 +0100

    Fix fused cpdef default arguments (cythonGH-4413)

    A couple of things were going wrong:
    * they're creating CloneNodes (but not requiring the contents of the clone of the clone node to be temp)
    * assignment from a clone node generates cleanup code (which is against the general rules of a clone node), and also loses a reference via giveref
    * cpdef functions cause a small memory leak (cython#4412) by assigning to their constants twice. This is unfortunately difficult to test for. With this patch we no longer leak, but still duplicate a little bit of work.

commit a0571a6
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Sun Oct 17 18:51:08 2021 +0100

    Import TextTestResult in test runner instead of _TextTestResult (cythonGH-4415)

    All the versions we currently test are new enough that the alias is no longer necessary.

commit c129b15
Author: Dobatymo <Dobatymo@users.noreply.github.com>
Date:   Fri Oct 15 16:31:32 2021 +0800

    Fix wrong type in unordered_multiset::swap() (cythonGH-4408)

commit 72c18e7
Author: 0dminnimda <0dminnimda@gmail.com>
Date:   Thu Oct 7 10:56:43 2021 +0300

    Improve ci-run.sh (cythonGH-4398)

commit 454a498
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Wed Oct 6 07:16:08 2021 +0100

    Improve "import_array" guard (cythonGH-4397)

    Stop using NPY_NDARRAYOBJECT_H since:
    a) in principle it's private
    b) Numpy has renamed it
    and use a public symbol instead.

    I think the existing tests are adequate - we just aren't yet testing
    against a new enough version of Numpy to have caught it yet.

    Closes cython#4396
    Closes cython#4394

commit 97c05e7
Author: Stefan Behnel <stefan_ml@behnel.de>
Date:   Sat Oct 2 11:08:43 2021 +0200

    Make a compile test runnable.

commit 8c7b0f3
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Fri Oct 1 10:29:34 2021 +0100

    Handle function "outer_attrs" more consistently (cythonGH-4375)

    A few children of function nodes need to be consistently evaluated
    outside the function scope. This PR attempts to do so and thus
    fixes cython#4367.

commit 494f517
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Fri Oct 1 10:22:36 2021 +0100

    Change gcc version check in test runner to a numeric comparison (cythonGH-4359)

    The string comparison was reporting '11' < '4' (so OpenMP tests were being skipped on GCC 11)

commit cce3693
Author: Christian Clauss <cclauss@me.com>
Date:   Wed Sep 29 09:49:45 2021 +0200

    Fix typo discovered by codespell (cython#4387)

commit daa0a44
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Tue Sep 28 08:48:12 2021 +0100

     Fix the name of attributes in the common ABI module  (cythonGH-4376)

    Attribute names used to be fully qualified like "_cython_3_0_0a9.cython_function_or_method" instead of the plain name.

    Closes cython#4373

commit fa8db66
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Mon Sep 27 10:11:12 2021 +0100

    Avoid AddTraceback() if stringtab isn't set up (cythonGH-4378)

    This can happen (rarely) with exceptions that occur very early in the module init process.

    Fixes cython#4377

    Uses a fake Numpy module for testing to make a version of "import_array" that always fails.

commit f94f26a
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Mon Sep 27 09:58:20 2021 +0100

    Make __Pyx_CoroutineAwaitType non-pickleable (cythonGH-4381)

    This is explicitly tested for: https://github.com/cython/cython/blob/aea4e6b84b38223c540266f8c57093ee2039f284/tests/run/test_coroutines_pep492.pyx#L2400

    It turns out some earlier versions of Python assume that
    C-API classes without a dict or slot are pickleable by the class
    name. Currently it isn't pickleable because the class name lookup
    is failing but this change makes it more robust.

    See cython#4376

commit 7403055
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Fri Sep 24 11:05:52 2021 +0100

    Avoid unnecessary binding of fused functions on class lookup (cythonGH-4370)

    Among other things this makes it pickleable by ensuring that it's the same object each time.

commit e2a23fe
Author: da-woods <dw-git@d-woods.co.uk>
Date:   Mon Sep 20 08:34:34 2021 +0100

    Remove usused "FetchCommonPointer" utility code (cythonGH-4380)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants