Skip to content

Commit 4c2f05a

Browse files
committed
[ doc ] update readme
1 parent 6cf7fe6 commit 4c2f05a

File tree

2 files changed

+28
-24
lines changed

2 files changed

+28
-24
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# HashedExpression [![wercker status](https://app.wercker.com/status/fce29884fa47e4258f62240000f1e368/s/master "wercker status")](https://app.wercker.com/project/byKey/fce29884fa47e4258f62240000f1e368)
2-
A type-safe Haskell-embeded DSL for solving optimization problems.
2+
3+
Type-safe modelling DSL, symbolic transformation of expressions (simplification and computing derivatives), and code generation for solving optimization problems.
4+
35

46
## Features
5-
- Provide a type-safe APIs to model optimization problems. This is achieved by employing Haskell's phantom-type and type-level programming, especially type-level natural numbers to properly constraint shape and element type (Real or Complex).
6-
- For example, we couldn't add 2 expression with mismatched shape/element type:
7+
- A type-safe, correct by construction APIs to model optimization problems, empowered by Haskell's phantom-type and type-level programming.
8+
- For example, adding 2 expressions with mismatched shape or element type (**R** or C) will result in type error will result in type error:
79
```haskell
810
λ> let x = variable1D @10 "x"
911
λ> let y = variable1D @9 "y"
@@ -55,8 +57,7 @@ Supported operations:
5557
- basic algebraic operations: addition, multiplication, etc.
5658
- complex related: real, imag, conjugate, etc.
5759
- trigonometry, log, exponential, power.
58-
- rotate
59-
- projection (think of Python's slice notation, but with type-safety), and injection (reverse of projection)
60+
- rotation, projection (think of Python's slice notation, but with type-safety), and injection (reverse of projection)
6061
- piecewise function
6162
- Fourier Transform, inverse Fourier Transform
6263
- dot product (inner product), matrix multiplication
@@ -182,5 +183,8 @@ List of contributors:
182183
- [Nhan Thai](https://github.com/dandoh)
183184
- [Curtis D'alves](https://github.com/dalvescb)
184185
- [Christopher Anand](https://github.com/christopheranand)
185-
- ...
186+
- [Christopher Schankula](https://github.com/CSchank)
187+
- [Nasim Khoonkari ](https://github.com/Nasim91)
188+
- [Habib Ghaffari Hadigheh](https://github.com/ghhabib2)
189+
- [Padma Pasupathi](https://github.com/padmapasupathi)
186190

wercker.yml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ create-release:
3232
- script:
3333
name: Create lbfgs-b archive
3434
code: |
35-
tar czfh lbfgs-b-$RELEASE_VERSION.tar.gz --directory=algorithms/lbfgs-b `ls algorithms/lbfgs-b`
35+
tar czfh lbfgs-b-$RELEASE_VERSION.tar.gz --directory=solvers/lbfgs-b `ls solvers/lbfgs-b`
3636
- script:
3737
name: Create ipopt archive
3838
code: |
39-
tar czfh ipopt-$RELEASE_VERSION.tar.gz --directory=algorithms/ipopt `ls algorithms/ipopt`
39+
tar czfh ipopt-$RELEASE_VERSION.tar.gz --directory=solvers/ipopt `ls solvers/ipopt`
4040
- wercker/github-create-release@2.1.1:
4141
token: $GITHUB_TOKEN
4242
tag: v$RELEASE_VERSION
@@ -53,21 +53,21 @@ create-release:
5353

5454

5555

56-
create-docker-image:
57-
box: hashexpression/symphony_env
58-
steps:
59-
- script:
60-
name: Remove unncessary directories & files
61-
code: |
62-
rm -rf .stack-work
63-
rm -rf .git
64-
- script:
65-
name: Copy symphony to PATH
66-
code: |
67-
cp bins/symphony /usr/bin
68-
- internal/docker-push:
69-
username: $DOCKERHUB_USERNAME # Registry username
70-
password: $DUCKERHUB_PASSWORD # Registry password
71-
repository: hashexpression/symphony
56+
# create-docker-image:
57+
# box: hashexpression/symphony_env
58+
# steps:
59+
# - script:
60+
# name: Remove unncessary directories & files
61+
# code: |
62+
# rm -rf .stack-work
63+
# rm -rf .git
64+
# - script:
65+
# name: Copy symphony to PATH
66+
# code: |
67+
# cp bins/symphony /usr/bin
68+
# - internal/docker-push:
69+
# username: $DOCKERHUB_USERNAME # Registry username
70+
# password: $DUCKERHUB_PASSWORD # Registry password
71+
# repository: hashexpression/symphony
7272

7373

0 commit comments

Comments
 (0)