Updating documentation.

Author: Mx7f

CHANGELOG.md

@@ -7,12 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 See the [roadmap](https://github.com/niessner/Opt/blob/master/ROADMAP.md) for near-future changes.
 
 ## [Unreleased]
+
+## [0.2.1] - 2017-10-25
 ### Added
 - Roadmap
 - Partially-automated regression test script.
 - Verbose-mode GPU memory usage reporting
+- Improved documentation 
+- Improved error messages
 
-### Fixed
+### Fixed 
 - [#91](https://github.com/niessner/Opt/issues/91): Graph energies with no unknown energies produce erroneous results
 
 ## [0.2.0] - 2017-10-22
@@ -32,6 +36,7 @@ See the [roadmap](https://github.com/niessner/Opt/blob/master/ROADMAP.md) for ne
 ### Fixed 
 - Memory leaks
 
-[Unreleased]: https://github.com/niessner/Opt/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/niessner/Opt/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/niessner/Opt/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/niessner/Opt/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/niessner/Opt/v0.1.0...v0.1.1

README.md

@@ -344,6 +344,21 @@ If you do not want the default behavior, you can use the `InBounds(x,y)` functio
 
 It is also possible to exclude arbitrary pixels from the solve using the `Exclude(exp)` method. When `exp` is true, unknowns defined at these pixels will not be updated and residuals at these pixels will not be evaluated.
 
+
+### ComputedArray ###
+
+Energy functions for neighboring pixels can share expensive-to-compute expressions. For instance,
+our [shape-from-shading example](https://github.com/niessner/Opt/blob/master/examples/shape_from_shading/shape_from_shading.t#L67) uses an expensive lighting calculation that is shared by neighboring pixels. We allow the user to turn these calculations into computed arrays, which behave
+like arrays when used in energy functions, but are defined as an expression of other arrays:
+
+    -- B_I is previously defined as a function that uses 
+    -- a large number of images. After this line, B_I can
+    -- be accessed like a regular Array or Image
+    B_I = ComputedArray("B_I", {W,H}, B_I(0,0))
+
+Computed arrays can include computations using unknowns, and are recalculated as necessary during the optimization. Similar to scheduling annotations in Halide, they allow the user to balance recompute with locality at a high-level.
+
+
 ### Vectors ###
 
     vector = Vector(a,b,c)

ROADMAP.md

@@ -6,14 +6,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 See the [roadmap](https://github.com/niessner/Opt/blob/master/ROADMAP.md) for near-future changes.
 
-## [0.2.1] - Estimated 2017-11-01
-### Adding
-- Improved documentation 
-- Improved error messages
-
-### Fixing 
-- [#91](https://github.com/niessner/Opt/issues/91): Graph energies with no unknown energies produce erroneous results
-
 ## [0.3.0] - Estimated 2017-11-07
 ### Adding
 - Automated performance testing