Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Pietro Vertechi committed Sep 21, 2018
1 parent 4ba0eed commit 4ed2677
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ julia> s.re
0.874437 0.929336
```

Note that the same approach can be used directly from an `Array` of complex numbers:

```julia
julia> StructArray([1+im, 3-2im])
2-element StructArray{Complex{Int64},1,NamedTuple{(:re, :im),Tuple{Array{Int64,1},Array{Int64,1}}}}:
1 + 1im
3 - 2im
```

## Example usage to store a data table

```julia
Expand All @@ -52,11 +61,3 @@ julia> push!(t, (a = 3, b = "z"))
(a = 2, b = "y")
(a = 3, b = "z")
```

## Lightweight package

This package aims to be extremely lightweight: so far it has 0 dependencies. One of the reasons to keep it so is to promote its use as a building block for table manipulation packages.

## Warning

The package is still pretty much under development and available only on Julia 0.7 (as it uses `NamedTuples` extensively).

0 comments on commit 4ed2677

Please sign in to comment.