Skip to content

Commit 6178bc9

Browse files
committed
Further small readme changes
1 parent a1c959f commit 6178bc9

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Until Julia 0.6 the package was registered as `VML.jl`.
88

99
## Basic install
1010

11-
To use IntelVectorMath.jl, you must have the shared libraries of the Intel Vector Math Library avilable on your system.
11+
To use IntelVectorMath.jl, you must have the shared libraries of the Intel Vector Math Library available on your system.
1212
The easiest option is to use [MKL.jl](https://github.com/JuliaComputing/MKL.jl) via
1313
```julia
1414
julia> ] add https://github.com/JuliaComputing/MKL.jl.git
@@ -23,9 +23,11 @@ julia> ] add https://github.com/JuliaMath/IntelVectorMath.jl
2323
```
2424

2525
## Using IntelVectorMath
26-
After loading `IntelVectorMath`, you have the supported function listed below available to call, i.e. `IntelVectorMath.sin(rand(100))`. For convenience the alias `IVM` is exported, so after `using` the package you can also call `IVM.sin(rand(100))` for short.
27-
If you `import` the package, you can add this alias (or any other) via `const IVM = IntelVectorMath`.
28-
This should provide a significant speed-up over broadcasting the Base functions.
26+
After loading `IntelVectorMath`, you have the supported function listed below, for example `IntelVectorMath.sin(rand(100))`. These should provide a significant speed-up over broadcasting the Base functions.
27+
Since the package name is quite long, an alias `IVM` is also exported to allow `IVM.sin(rand(100))` after `using` the package.
28+
If you `import` the package, you can add this alias via `const IVM = IntelVectorMath`. Equally, you can replace `IVM` with another alias of your choice.
29+
30+
#### Example
2931
```julia
3032
julia> using IntelVectorMath, BenchmarkTools
3133

@@ -72,7 +74,7 @@ julia> exp(ones(2,2))
7274
julia> ans == exp.(ones(2,2))
7375
true
7476
```
75-
If your code, or any code you call, uses matrix exponentiation, then `@overload exp` may silently lead to incorrect results. This caution applies to all trigonometric functions, too, since they have matrix forms defined by matrix exponential.
77+
If your code, or any code you call, uses matrix exponentiation, then `@overload exp` may silently lead to incorrect results. This caution applies to all trigonometric functions, too, since they have matrix forms defined by matrix exponentials.
7678

7779
### Accuracy
7880

@@ -161,11 +163,11 @@ Next steps for this package
161163
* [x] Windows support
162164
* [x] Basic Testing
163165
* [x] Avoiding overloading base and optional overload function
164-
* [ ] Updating Benchmarks
165166
* [x] Travis and AppVeyor testing
166167
* [x] Adding CIS function
168+
* [ ] Updating Benchmarks
167169
* [ ] Add tests for mutating functions
168-
170+
* [ ] Add test for using standalone MKL
169171

170172

171173
## Advanced

0 commit comments

Comments
 (0)