ADTs

Apply to access the comprehensive PDF slide set accompanying the Webel Mathematica libraries technical slide trail

Keywords

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.

If you are interested in Mathematica, the Wolfram Language, or Systems Modeling Language v1 (SysML^®) you may be interested in accessing the very comprehensive accompanying

Apply to access the comprehensive PDF sli

Mathematica: Webel ADT pseudo classes: 'Q: Do I have to use these EX$Val scalar "atom" thingies and the EX$Row, EX$RowList, and EX$RowMap? Can't I just use Wolfram Language Lists and Associations?' A: Of course you can also use the basic Wolfram Language!

Mathematica: Webel ADT pseudo classes: An EX$Val has concise methods for testing the type of its wrapped '$$' value: isR, isI, isB, isQ, isS. These may be used in ADT "constructor" type tests.

Mathematica: Webel ADT pseudo classes: The validity of the type of a wrapped '$$' value of an EX$Val may be checked in ADT "constructors" which have type checking utility support. This strategy has been chosen over sub-types of EX$Val.

Mathematica: Webel ADT pseudo classes: There does not seem to be a way to register ::usage specific to a Webel ADT-Method (TagSetDelayed UpValue). The Webel libraries offer method documentation support via the HelpO` class/method registry.

Mathematica: Webel ADT pseudo classes: Webel ADT-Methods support Wolfram Language Options[] as TagSetDelayed UpValues (but there are some pros and cons). Webel ADT-Methods work with the Webel HelpO` class/method registry, including rich help on options.

Mathematica: Webel ADT pseudo classes: «adt:ref» applied to a property indicates that it is resolved by ID through the ADT store using adt$fetch[id]. Use adt$store[adt] for very large ADTs and for cleaner ADT views and easier Notebook development.

Mathematica: Webel OpenXML: The XL$Cell value accessor XL$Cell⊙valReal has no units-awareness; prefer the US$Cell value accessor US$Cell⊙val, which can return a Quantity.

Mathematica: Webel ADT pseudo classes: POLICY: Where an ADT-Method uses UUID-driven Once[] caching the trigger argument is a String '$uuid' which MUST have a default None and MUST be the first argument that has a default.

SECTION: Webel ADT case study: Extracting structured data from unstructured Open XML spreadsheet data

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.

Overview of the Webel OpenXML libraries ADT Case Study

ADT hierarchy for the XL` package for reading unstructured data from OpenXML XLSM bundles

ADT hierarchy for the US` package with intermediate unstructured data and identification of data groups

ADT hierarchy for the EX`package for extracted structured data

ADT hierarchy for a typical Client Data (CD) layer for identifying structured data groups

Typical unstructured spreadsheet data imported into the XL layer

XL$Row and XL$Cell under the hood

XL$Cell value resolution for “text” requires an XL$ResourcesMap (Real, Integer, and Boolean value resolution does not)

UUID-driven Once-caching. Example: XL$Cell value resolution with an XL$ResourcesMap

XL$Cell with a VBA formula and XL$F

XL$RowList vs XL$Row vs XL$Cell

Spreadsheet “units indicator” HACKS do NOT use a units-aware Quantity algebra!

Units and Quantity extraction with US$Row

US$RowList spanned rows filling

US$RowList sub-list extraction

US$RowList & EX$RowMap column extraction and custom styled tables

US$RowList “section” extraction

UD` demo package for US$Section

UD` demo: Basic US$ValuesSection

US$ValuesSection to EX$RowMap

US$SectionMap auto-detection

Specific Component-aware sub-ADTs

Demo Component values extraction (but not yet as EX Component ADTs)

The demo UD$EX$Component for extracted structured EX Layer data

The US$SheetManager as a bridge between the US Layer and EX Layer

Extracted demo UD$EX$Component:Demo UD$EX$Components: Creative views in the UD$SheetManager

Demo UD$EX$Components analyser

UD$EX$Components as (quick) XML

UD$EX$Component “database” demo (using a Wolfram Language EntityStore)

Mathematica: Webel ADT pseudo classes: The SysMLv1 models are supported by custom stereotypes with icons. Some of these indicate OO-similar use of ADT-Methods and departures from formal Abstract Data Type (ADT) definitions.

Mathematica: Webel ADT pseudo classes: The ADT⊙get method may be used to access the '$$' wrapped primary. This is intended for development and testing purposes only (not for regular use by clients) since it BREAKS ENCAPSULATION!

SECTION: The Webel Abstract Data Type (ADT) stateless pseudo-classes with inheritance (with SysMLv1 models)

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.

Introduction to Webel Abstract Data Types (ADTs) with SysMLv1 models

Webel Abstract Data Types (ADTs) vs the user-contributed MTools for OO

Webel ADTs include inheritance (and aren’t actually formal ADTs)

Webel ADT hierarchy views as tree, graph, and SysML

Mini SysMLv1 BDD view of the Webel ADT Block

SysMLv1 Internal Block Diagram (IBD) of the Webel ADT base class

Webel ADT`package: Some ADT pseudo class utility functions in a ::usage help viewer. Diagnostic, help, and development functions.

Simple Webel ADT in the development view dV[adt] and class/methods help hC[adt]

Classes in the ADT` package: Extendable ADT pseudo classes have corresponding "definer functions"

Creating new ADTs that extend other classes using a definer function (and adt$addSuper)

Extending ADT sub-classes represented as SysML Blocks with redefined wrapped ‘$$’

Webel «adt:pseudo» elements in the SysMLv1 ADT model (1)

Webel «adt:pseudo» elements in the SysMLv1 ADT model (2)

Chained wrapped ADT pseudo Lists: Example: EX` package structured data ADTs

Chained wrapped ADT pseudos as a SysMLv1 Internal Block Diagram (IBD)

Clients of List ADTs don’t usually directly access the wrapped Lists (but can for testing with ADT⊙get which BREAKS ENCAPSULATION)

Webel ADT SysMLv1 Stereotypes

adt$graphHierarchy example: The EX` package for structured data

ADT finder functions and “methods” adt$findUp, adt$findUpArg, ADT⊙fM

ADT help functions and methods: adt$treeHierarchy (adt$tH), adt$hC, ADT⊙hC: Example: XL$Cell

ADT`: helpADT[class]: help on methods registered with HelpO`: Example: XL$Cell

adt$store, adt$fetch, and «adt:ref»: Example: Reference XL$ResourcesMap by ID in US$ResourcesHolder.

Mathematica: Webel ADT pseudo classes: POLICY: The ADT-Methods of an ADT-Class are created as TagSetDelayed UpValues using the 'signature' of the ADT-Class and its defining 'pattern' as 1st argument

Mathematica: Webel ADT pseudo classes: CONVENTION: PROVISIONAL: The infix operator for calling ADT-Methods on ADT "objects" is the CircleDot (⊙ in Notebooks). ISSUE: \[CircleDot] is NOT GOOD FOR USE IN IDEs!

Dr Darren of Webel IT Australia makes the case for better object-orientation for Mathematica using pseudo class ADTs without losing the super-functional power of the Wolfram Language

Gallery

Tutorial

Mathematica: POLICY NOTES for the Webel Abstract Data Type (ADT) pseudo classes with inheritance for the Wolfram Language

Section

Mathematica: Webel ADT pseudo classes: POLICY/DEFINITION: Every "hard coded" definer or defining client of a definer has a corresponding ADT ArchetypeClass. Example ("hard coded"): The definer 'my$def$MY$SmartList' has ArchetypeClass 'MY$SmartList'.

Mathematica: Webel ADT pseudo classes: TIP: Prefer the Decorator Pattern over multiple inheritance of ADT-Method UpValues! (But not because "inheritance is evil" per se, it isn't.) The base ADT libraries make heavy (and very useful) use in inheritance.

Mathematica: Webel ADT pseudo classes: A tricky POLICY & CONVENTION: Client packages MUST access the special "wrapped" primary '$$' via $ContextAliases! The recommended alias is "A`" (which stands of course for ADT).

Mathematica: Webel ADT pseudo classes: POLICY: Multiple inheritance is supported via ONE (only) ADT-Class and one or more ADT-MemberInterfaces (which have no ADT-Method UpValues)

Mathematica: Webel ADT pseudo classes: POLICY: Definer functions MUST return the self-declared or injected 'pattern' that determines the unique "ADT-signature" of the defined ADT class.

Mathematica: Webel ADT pseudo classes: ADTs that define membership of ADT-classes in a domain package have ADT-signature MemberInterface[$$:None] and MUST NOT populate ADT-method UpValues in their definers.

Mathematica: Webel ADT pseudo classes: NAMING CONVENTION: An UpValue that can be invoked on an ADT accepting its unique 'signature' pattern as (at least) 1st argument is called an 'ADT-Method'. They are NOT methods in the general object-oriented sense!

Mathematica: Webel ADT pseudo classes: There is an 'ADT' universal base that has no supers. It "blesses" every other sub-class ADT by populating it with some common ADT-Method UpValues against a signature pattern via the 'adt$def$All[]' definer function.

Mathematica: Webel ADT pseudo classes: DEFINITION/CONVENTION: Functions that populate ADTs with reusable ADT-method UpValues are called 'definers' and include '$def' in the name after a Package scope indicator: Example: adt$def$ADT, my$def$MY$CleverList

Mathematica: Webel ADT pseudo classes: POLICY: Every named concrete Abstract Data Type (ADT) has a ONE unique "signature" (which is the pattern passed to the "definer" functions). To vary a signature, define another unique ADT name.

Mathematica: Webel ADT pseudo classes: POLICY: The Abstract Data Types (ADTs) are stateless functional (although inheritance and overrides are supported), with no caching by default (although there is nice optional caching using CreateUUID[] and Once[]).

Mathematica: Webel ADT: The term 'Abstract Data Types (ADT)' is used informally (the Webel ADTs do not always adhere to strict definitions of ADTs). Please just think of it here as meaning a strong type or stateless "pseudo class".

Mathematica: Webel ADT pseudo classes: POLICY: The expression '$$' is reserved as the primary named parameter for the defining pattern of all ADT classes that extend the universal base 'ADT' class.

Mathematica: Webel: You get compelling incremental value out of Mathematica even if you don't yet command all of the syntax and massive powers of the Wolfram Language!

Mathematica: POLICY NOTES for the Webel Abstract Data Type (ADT) pseudo classes with inheritance for the Wolfram Language

Jump to first slide

Dr Darren of Webel IT Australia makes the case for better object-orientation for Mathematica using pseudo class ADTs without losing the super-functional power of the Wolfram Language

Sections

TIP: Mathematica: Webel's ultimate guide to using Abstract Data Types to create "pseudo classes" (strong types) with inheritance for the Wolfram Language, all modelled in SysML!

Subscribe to ADTs