Skip to content

Commit 2d51d07

Browse files
hayatoikomaJutho
authored andcommitted
Remove isreal argument in the constructor in README (#18)
1 parent e7b08c8 commit 2d51d07

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ The LinearMaps package provides the following functionality:
3737
General purpose method to construct `LinearMap` objects of specific types, as described in the Types section below
3838

3939
```
40-
LinearMap{T}(A::AbstractMatrix[; isreal::Bool, issymmetric::Bool, ishermitian::Bool, isposdef::Bool])
41-
LinearMap{T}(A::LinearMap[; isreal::Bool, issym::Bool, ishermitian::Bool, isposdef::Bool])
40+
LinearMap{T}(A::AbstractMatrix[; issymmetric::Bool, ishermitian::Bool, isposdef::Bool])
41+
LinearMap{T}(A::LinearMap[; issym::Bool, ishermitian::Bool, isposdef::Bool])
4242
```
4343
44-
Create a `WrappedMap` object that will respond to the methods `isreal`, `issymmetric`, `ishermitian`, `isposdef` with the values provided by the keyword arguments, and to `eltype` with the value `T`. The default values correspond to the result of calling these methods on the argument `A`; in particular `{T}` does not need to be specified and is set as `eltype(A)`. This allows to use an `AbstractMatrix` within the `LinearMap` framework and to redefine the properties of an existing `LinearMap`.
44+
Create a `WrappedMap` object that will respond to the methods `issymmetric`, `ishermitian`, `isposdef` with the values provided by the keyword arguments, and to `eltype` with the value `T`. The default values correspond to the result of calling these methods on the argument `A`; in particular `{T}` does not need to be specified and is set as `eltype(A)`. This allows to use an `AbstractMatrix` within the `LinearMap` framework and to redefine the properties of an existing `LinearMap`.
4545
4646
```
4747
LinearMap{T}(f, [fc = nothing], M::Int, [N::Int = M]; ismutating::Bool, issymmetric::Bool, ishermitian::Bool, isposdef::Bool])

0 commit comments

Comments
 (0)