summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeter Baumann <p.baumann@jacobs-university.de>2010-09-04 18:11:50 +0200
committerwww-data <www-data@ubuntu.localdomain>2010-10-31 12:56:55 +0100
commit7e98f5d063388493423ff73d347a91544bfa75af (patch)
tree923b8ad76924d94023dc926f48bd64c598103d03
parent0b5d37c73c89cffff7008701a07f1fef3c8df5f0 (diff)
downloadrasdaman-upstream-7e98f5d063388493423ff73d347a91544bfa75af.tar.gz
rasdaman-upstream-7e98f5d063388493423ff73d347a91544bfa75af.tar.xz
rasdaman-upstream-7e98f5d063388493423ff73d347a91544bfa75af.zip
improved inline documentation
-rw-r--r--manuals_and_examples/examples/rasdl/basictypes.dl37
1 files changed, 17 insertions, 20 deletions
diff --git a/manuals_and_examples/examples/rasdl/basictypes.dl b/manuals_and_examples/examples/rasdl/basictypes.dl
index 60c9123..2578f0e 100644
--- a/manuals_and_examples/examples/rasdl/basictypes.dl
+++ b/manuals_and_examples/examples/rasdl/basictypes.dl
@@ -22,48 +22,45 @@ rasdaman GmbH.
*/
// ---------------------------------------------------------------------
//
-//
// PURPOSE:
-// This file contains type definitions to challenge the rasdl utilit.
-// Rasdl needs to read them and react appropriately. Reports are done
-// to stdout.
+// This file contains rasdaman type definitions. During database creation,
+// these are normally imported through
+// rasdl --read basictypes.dl --insert
+//
+// This is not mandatory, though. The cell base types are available anyway,
+// and if you decide you need other MDD and ollection types than the ones
+// provided here then it is safe to skip importing this file.
//
+// See the Rasql Query Language Guide for an explanation of the syntax.
//
-// COMMENTS:
-// ./.
-//
-//
// ---------------------------------------------------------------------
-// --- good defs -------------------------------------------------------
-// --- bad defs --------------------------------------------------------
-
-
-
-// example 1
+// 2D greyscale image of unlimited spatial extent
typedef marray <char,2> GreyImage;
typedef set<GreyImage> GreySet;
-// example 2
+// 2D binary image of unlimited spatial extent
typedef marray <boolean,2> BoolImage;
typedef set<BoolImage> BoolSet;
-// example 3
+// 2D RGB image of unlimited spatial extent
struct RGBPixel { char red, green, blue; };
typedef marray <RGBPixel,2> RGBImage;
typedef set<RGBImage> RGBSet;
-// example 4
+// 2D 32-bit pixel of unlimited spatial extent
typedef marray <unsigned long, 2> ULongImage;
typedef set<ULongImage> ULongSet;
-// example 5
+//
+// these above may serve as examples of the principle.
+// Below more types which are useful in practice.
+//
+
typedef marray <char, 3> GreyCube;
typedef set<GreyCube> GreySet3;
-
-// heavily expanded types (Andreas)
typedef marray <boolean, 1> BoolString;
typedef set<BoolString> BoolSet1;