diff Grids/src/AbstractGrid.jl @ 212:aa17d4d9d09e package_refactor

Export some functions from AbstractGrid and move documentation to docstrings
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 26 Jun 2019 11:00:34 +0200
parents 1ad91e11b1f4
children b3506cfbb9d8
line wrap: on
line diff
--- a/Grids/src/AbstractGrid.jl	Wed Jun 26 10:44:20 2019 +0200
+++ b/Grids/src/AbstractGrid.jl	Wed Jun 26 11:00:34 2019 +0200
@@ -1,14 +1,22 @@
+"""
+     AbstractGrid
+
+Should implement
+    dimension(grid::AbstractGrid)
+    points(grid::AbstractGrid)
+
+"""
 abstract type AbstractGrid end
 
-function dimension(grid::AbstractGrid)
-    error("Not implemented for abstact type AbstractGrid")
-end
+function dimension end
+function points end
+export dimension, points
 
-function points(grid::AbstractGrid)
-    error("Not implemented for abstact type AbstractGrid")
-end
+"""
+    evalOn(g::AbstractGrid, f::Function)
 
-# Evaluate function f on the grid g
+Evaluate function f on the grid g
+"""
 function evalOn(g::AbstractGrid, f::Function)
     F(x) = f(x...)
     return F.(points(g))