No_std support for ndarray #864

SparrowLii · 2020-12-17T12:53:18Z

This pr enables ndarray to be used in the no_std environment, and maintains most of the functions. Fixes #708.
The geomspace linspace logspace range var_axis and std_axis methods are only available when std is enabled at current. And 'blas''rayon''serde' features are not available without std too.

catch_unwind is implemented in std

It looks like core is not found in oper.rs

SparrowLii · 2020-12-17T13:58:34Z

libcore cannot be used in blas-tests/oper.rs, which is a bit strange

bluss · 2020-12-17T21:39:47Z

Hm, do we need to start it this way? I'd suggest using the extern crate core as std solution, as I mentioned in the issue.

We need to figure out which tests to run in the no-std configuration. Crate test in itself depends on std, so we can keep using std in the test files.

SparrowLii · 2020-12-18T01:02:55Z

In that case, it means that all dependencies on std in ndarray must be handled at once. Well, I will try that method.

src/iterators/mod.rs

SparrowLii · 2020-12-23T06:14:24Z

@bluss It seems that we need to resolve the dependencies of external cretas next. Do you think we should do it together here or in a new pr?

[Edit]They are mainly num-trait::Float and serde( and maybe others ). I can solve the former by using the limb feature in num-trait, while the latter is an optional package I haven’t changed for now.
My current goal is to first enable ndarray to be used in no_std environment, WDYT?

Cargo.toml

…space、var_axis、std_axis cannot use.

SparrowLii · 2020-12-24T07:36:43Z

@bluss now it use FloatCore as Float in no_std environment. I think it will not affect the function under the std environment and can theoretically be used under no_std

bluss · 2020-12-24T11:48:36Z

@SparrowLii That kind of solution (FloatCore as Float) is not someting we can use in our public interface, it will create incompatibilities between our dependencies (it's a non-additive change to our API depending on features, which is not allowed).

crate features must be additive. When enabling std we can only enable more API, not change the definition of existing ones.

bluss · 2020-12-24T11:50:20Z

src/lib.rs

+#[cfg(feature = "std")]
+pub use num_traits::Float;
+#[cfg(not(feature = "std"))]
+pub use num_traits::float::FloatCore as Float;


This line must be deleted. Then we follow the consequence of that for not(feature="std").

If we need a creative solution, then we can "redirect" to support only f32, f64 on no-std (not general FloatCore!). Then we can feature-safely expand our methods bounded on A: Float to support the full A: Float range with std.

Apologies for my lack of experience. I will change it.
I think it is cool to expand for FloatCore under no_std, but if we don’t use libm, we might have to implement exp() and ln() functions ourselves. I doubt about that.

SparrowLii · 2020-12-24T12:36:04Z

If we need a creative solution, then we can "redirect" to support only f32, f64 on no-std (not general FloatCore!). Then we can feature-safely expand our methods bounded on A: Float to support the full A: Float range with std.

Apologies for my lack of experience. Have changed it.
I think it is cool to expand for FloatCore under no_std, but if we don’t use libm, we might have to implement exp() and ln() functions ourselves. I doubt about that.

bluss · 2020-12-24T13:57:38Z

Replacing the libm feature is not a goal no, don't worry about that.

SparrowLii · 2020-12-24T14:34:24Z

Replacing the libm feature is not a goal no, don't worry about that.

Sorry for a little not understanding. So it means adding libm features or expand for FloatCore ourselves in ndarray?:)

SparrowLii · 2020-12-25T07:14:49Z

Added libm features, so we can use --no-defualt-features --features "libm" to use all Float functions under no_std

SparrowLii · 2020-12-25T10:04:26Z

@bluss any more advice? I think it can already be used under no_std. Maybe we should find a good way to verify?

src/impl_constructors.rs

bluss · 2020-12-29T20:42:39Z

I think this is a hard task if we try to do the impossible (making FloatCore/Float fit together). Let's follow a simple recipe which means that std is an additive feature. When std is disabled, some API is going to be missing because of that.

Anything else than that can be improved later.

src/lib.rs

SparrowLii · 2020-12-30T01:11:25Z

I think this is a hard task if we try to do the impossible (making FloatCore/Float fit together). Let's follow a simple recipe which means that std is an additive feature. When std is disabled, some API is going to be missing because of that.

Anything else than that can be improved later.

Okay then, it should be better.

SparrowLii · 2021-01-07T12:51:32Z

@bluss Now we avoid using the Float feature in the no_std environment. It can run under no_std. WDYT?

bluss · 2021-01-07T20:30:57Z

Great work, looks like it works. That's all we need for now. Features can be added back later.

Do we have enough tests? There should be a test that ensures we build properly in no-std, not using std, and it should run in CI.
Look at feature documentation. Features are documented in the module doc and in the README like this, and we need to add something for std. See link https://docs.rs/ndarray/0.14.0/ndarray/#crate-feature-flags
We need to document on the features themselves. See in our docs you can find we say Requires crate feature "approx" on items that require that feature and so on. (There is an experimental Rust feature for nicer looking labels for this - but we don't need to use that feature yet if you don't want to - we can keep it simple and migrate everything to that later)
Update the PR title, PR description and make them ready for merge. Update the description so that it properly says that it fixes the issue that it fixes, not just talks about it.
Use interactive rebase to squash and clean up history (optional) - the PR commits are a bit messy - if you want to skip this, this change can be "squash merged", as one commit instead.

Cargo.toml

SparrowLii · 2021-01-08T07:17:28Z

@bluss I updated the description of std feature and updated the pr description. But there are still two problems:
I did build test on linux-armv7(cargo build --target=thumbv7m-none-eabi --no-default-features)and it built successfully. But because I don’t know much about CI, I don’t know how to add it to the CI test script. I try to refer to the no_std of matrixmultiply, but there is no .travis.yml file in the ndarray.
I am happy to help optimize the document, but apart from adding a description of the std feature, I can’t find specific places to do it.
In addition, I tried to rebase, but encountered a lot of conflicts that I could not handle, so I thought it would be better to execute "squash merged".

bluss · 2021-01-08T08:49:13Z

README.rst

+    default `std` feature. Use this in `Cargo.toml`:
+
+    [dependencies]
+    ndarray = { version = "0.14.0", default-features = false }


Example with the version is nice but we should not use a specific version. Just more places to update when we bump the version. So we don't make an explicit example like this.

I think we also need to put the same update about feature flags into src/lib.rs - the module docs.

OK, has updated

src/lib.rs

README.rst

src/iterators/macros.rs

bluss · 2021-01-10T13:58:34Z

Thanks! Finally done

SparrowLii and others added 5 commits December 11, 2020 17:18

Replace the replaceable "std" with "core"

84767e2

Replace the replaceable "std" with "core"

599536e

Merge branch 'master' into no_std

8c423ee

Update azip.rs

7e7735d

catch_unwind is implemented in std

Update oper.rs

b59f41c

It looks like core is not found in oper.rs

SparrowLii changed the title ~~Replace the replaceable "std" statement in ndarray with "core"~~ [WIP]Replace the replaceable "std" statement in ndarray with "core" Dec 18, 2020

SparrowLii added 3 commits December 19, 2020 10:30

use std in tests

ffc6780

add #![no_std] in lib.rs

770d902

use std in other tests

7066597

SparrowLii changed the title ~~[WIP]Replace the replaceable "std" statement in ndarray with "core"~~ [WIP] Replace the replaceable "std" statement in ndarray for no_std Dec 19, 2020

bluss reviewed Dec 19, 2020

View reviewed changes

src/iterators/mod.rs Outdated Show resolved Hide resolved

add "use crate core as std"

32fc255

Change dependent crate features for no_std

93d4f6e

SparrowLii changed the title ~~[WIP] Replace the replaceable "std" statement in ndarray for no_std~~ [WIP] no_std support for ndarray Dec 23, 2020

bluss reviewed Dec 23, 2020

View reviewed changes

Cargo.toml Show resolved Hide resolved

bluss reviewed Dec 23, 2020

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

SparrowLii added 2 commits December 24, 2020 15:18

use FloatCore as Float in no_std environment. Therefore geomspace、log…

c621b70

…space、var_axis、std_axis cannot use.

not use libm; use std in matrixmultiply

08c65f1

bluss reviewed Dec 24, 2020

View reviewed changes

delete pub use Float in lib.rs

d9b8db6

add libm feature to support Float in no_std

97f9572

bluss reviewed Dec 28, 2020

View reviewed changes

src/impl_constructors.rs Outdated Show resolved Hide resolved

bluss reviewed Dec 29, 2020

View reviewed changes

src/lib.rs Outdated Show resolved Hide resolved

not use Float in no_std

a66c23c

bluss reviewed Jan 7, 2021

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

Update some documents

f2ff012

SparrowLii changed the title ~~[WIP] no_std support for ndarray~~ No_std support for ndarray Jan 8, 2021

bluss reviewed Jan 8, 2021

View reviewed changes

SparrowLii and others added 4 commits January 9, 2021 17:19

update document

999c2fd

Merge branch 'master' into no_std

1a37571

Resolve errors caused by the updates

8be45a0

update document

0a54342

bluss reviewed Jan 10, 2021

View reviewed changes

src/lib.rs Outdated Show resolved Hide resolved

bluss reviewed Jan 10, 2021

View reviewed changes

README.rst Outdated Show resolved Hide resolved

bluss reviewed Jan 10, 2021

View reviewed changes

README.rst Outdated Show resolved Hide resolved

Remove mention of all_close - this method is removed

9f9e5f8

bluss reviewed Jan 10, 2021

View reviewed changes

src/iterators/macros.rs Outdated Show resolved Hide resolved

src/iterators/macros.rs Outdated Show resolved Hide resolved

Small edits to comments

391824b

bluss merged commit d27b1a9 into rust-ndarray:master Jan 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

No_std support for ndarray #864

No_std support for ndarray #864

SparrowLii commented Dec 17, 2020 •

edited by bluss

Loading

SparrowLii commented Dec 17, 2020

bluss commented Dec 17, 2020

SparrowLii commented Dec 18, 2020

SparrowLii commented Dec 23, 2020 •

edited

Loading

SparrowLii commented Dec 24, 2020

bluss commented Dec 24, 2020 •

edited

Loading

bluss Dec 24, 2020

bluss Dec 24, 2020

SparrowLii Dec 24, 2020

SparrowLii commented Dec 24, 2020

bluss commented Dec 24, 2020

SparrowLii commented Dec 24, 2020 •

edited

Loading

SparrowLii commented Dec 25, 2020

SparrowLii commented Dec 25, 2020

bluss commented Dec 29, 2020 •

edited

Loading

SparrowLii commented Dec 30, 2020

SparrowLii commented Jan 7, 2021

bluss commented Jan 7, 2021

SparrowLii commented Jan 8, 2021

bluss Jan 8, 2021

bluss Jan 8, 2021

SparrowLii Jan 9, 2021

bluss commented Jan 10, 2021

No_std support for ndarray #864

No_std support for ndarray #864

Conversation

SparrowLii commented Dec 17, 2020 • edited by bluss Loading

SparrowLii commented Dec 17, 2020

bluss commented Dec 17, 2020

SparrowLii commented Dec 18, 2020

SparrowLii commented Dec 23, 2020 • edited Loading

SparrowLii commented Dec 24, 2020

bluss commented Dec 24, 2020 • edited Loading

bluss Dec 24, 2020

Choose a reason for hiding this comment

bluss Dec 24, 2020

Choose a reason for hiding this comment

SparrowLii Dec 24, 2020

Choose a reason for hiding this comment

SparrowLii commented Dec 24, 2020

bluss commented Dec 24, 2020

SparrowLii commented Dec 24, 2020 • edited Loading

SparrowLii commented Dec 25, 2020

SparrowLii commented Dec 25, 2020

bluss commented Dec 29, 2020 • edited Loading

SparrowLii commented Dec 30, 2020

SparrowLii commented Jan 7, 2021

bluss commented Jan 7, 2021

SparrowLii commented Jan 8, 2021

bluss Jan 8, 2021

Choose a reason for hiding this comment

bluss Jan 8, 2021

Choose a reason for hiding this comment

SparrowLii Jan 9, 2021

Choose a reason for hiding this comment

bluss commented Jan 10, 2021

SparrowLii commented Dec 17, 2020 •

edited by bluss

Loading

SparrowLii commented Dec 23, 2020 •

edited

Loading

bluss commented Dec 24, 2020 •

edited

Loading

SparrowLii commented Dec 24, 2020 •

edited

Loading

bluss commented Dec 29, 2020 •

edited

Loading