variable_advanced_types - Anobium/Great-Cow-BASIC-Help GitHub Wiki

About Variable Advanced Types

A variable is an area of memory on the microcontroller that can be used to store a number or other data.   This is useful for many purposes, such as taking a sensor reading and acting on it, or counting the number of times the microcontroller has performed a particular task.

Each variable must be given a name, such as "MyVariable" or "PieCounter".   Choosing a name for a variable is easy - do not include spaces or any symbols (other than _), and make sure that the name is at least 2 characters (letters and/or numbers) long.

Advanced Types

There are a number different types of advanced variable types, and each type can store a different range of numeric information.   With respect to advanced variables Great Cow BASIC supports:

However, using large integers and floats point maths is also much slower than integer maths when performing calculations and loops, therefore should be avoided if.   You should convert float calculations to integer maths to increase operation of your solution.   The example program (shown below) shows how use a float maths and how to achieve the same calculation using integer maths.  

The advanced variable types that Great Cow BASIC supports are:

The format for single and double floats is defined by the IEEE 754 standard.   Sign, exponent and mantissa are all in the positions described here: https://www.geeksforgeeks.org/ieee-standard-754-floating-point-numbers/

Organisation of advanced variables

Great Cow BASIC stores advanced variables in bytes.   The format of these bytes is:

_ D, _C, _B, _A, _E, _U, _H, variable_name  ( from high to Low)

You can access the bytes within advanced variables using the following as a guide using the suffixes _A, _B, _C etc.

Example of accessing the lowest byte, the _H, _U and the _A bytes.

    Dim workvariable as longInt
    workvariable = 21845
    Dim lowb as byte
    Dim highb as byte
    Dim upperb as byte
    Dim lastb as byte


    lowb = workvariable
    highb = workvariable_H
    upperb = workvariable_U
    lastb = workvariable_A

Using Advanced Variables

Advanced variables must be "DIMensioned" first.  This involves using the DIM command, to tell Great Cow BASIC that it is dealing with an advanced variable.

    Dim myLongInt as LongInt
    myLongInt = 922337203685477           '2 ^ 63 - 1 or  9223372036854775807

    Dim myuLongInt as uLongInt
    myuLongInt = 0xFFFFFFFFFFFFF          '2 ^ 64 - 1  or  18446744073709551615

    Dim mySingle as Single
    mySingle= 1.1

    Dim myDouble as Double
    myDouble=3.141592

Using Advanced Variables

Advanced variables are only supported by a subset of the functions of Great Cow BASIC.  

If the function is NOT shown below assume the function is NOT supported.  If you use a function that is not shown below then you may get a silent failure and you may not get the results you expected.

The functional characteristics are:

Functions explicitly not supported

These are the functions that are not supported.   Assuming that a function is not supported is the best approach when using advanced variables.   Use of these functions may cause an error message or may silently fail producing invalid ASM.
Functionality explicitly not supported is shown below.  

Assigning Values to Advanced Variables

You can assign values to advanced variables using  `=`.  

A simple, but typical example follows.  This is the typical for numeric variable assignment.

    Dim myLontINT as LontINT
    myLontINT = 0XFFFFFF       'assign the value of 16777215

Another example is bitwise assignments as follows:

    myLontINT.16 = 1  'set the single bit to 1

INT() and ROUND()

Floating point numbers are not exact, and may yield unexpected results when compared using conditions (IF etc).   For example 6.0 / 3.0 may not equal 2.0.   Users should instead check that the absolute value of the difference between the numbers is less than some small number.

These techniques replace the INT() and ROUND() functions.

Pseudo INT()

Using the INT() function is not supported.  

So, use the conversion from floating point to integer as this results in integer truncation.

        dim mySingleVar as Single
        mySingleVar = 2.9  'A float type variable

        dim myLongVar as Long
        myLongVar = mySingleVar ' will set myLongVar to 2

Pseudo ROUND()

Using the ROUND() function is not supported.  

So, to round off during the conversion process, add 0.5:  As follows:

        'Add 0.5 to a single or double and then assign to an integer variable

        dim mySingleVar as Single
        mySingleVar = 2.9

        dim myLongVar as Long
        myLongVar= mySingleVar + [single]0.5  '3

Example Program

This program shows the values of calculation of 4.5 * multiplied by a number ( 4.5 x a range of 0 to 40,000).   The program shows setting up the advanced variables, assigned a value and completing the multiplication of the initial value using a repeat loop.   The repeat loop is used as advanced variables are are not supported by multiplication ( or division ), so, using the repeat an alternative to multiplication, just a lot slower.  

The program using advanced variables to show the results, and, then uses factorised ineger maths to show the results.   The performance of each approach can be examined on the serial terminal.

    HSerPrintCRLF 2
    HSerPrint "Maths test "
    HSerPrintCRLF 2

    DIM multiplier as Word
    DIM ccount as Double
    DIM calcresult as Single
    Dim result as Long

    HSerPrint "Use floats with pseudo multiplier  maths"
    HSerPrintCRLF

    'Assign a value to a double variable
    ccount   = 4.5

      For  multiplier = 0 to 40000 step 2500
        calcresult = 0

        'Do some maths... multiplier x ccount .... slow but as there is NO multi or divide for floats.. this is a method to simulate a multiplier operation
        Repeat multiplier
            calcresult = calcresult + ccount
        End Repeat

        HSerPrint "4.5"
        HSerPrint " x "
        HSerPrint left(str32(multiplier)+"        ", 8 )
        HSerPrint " = "

        'Convert Single to Long to get the result
        result = calcresult
        HSerPrint left(str32(result)+"        ", 8 )

        'Now do the scale maths - this can all be done in integer maths
        HSerPrint " scaled result = "
        result = 180-(result/1000)
        HSerPrint Result
        HSerPrintCRLF
        wait 100 ms

      next


    'Use conventional Integer number using facttoristion
    HSerPrint "Use factored integer maths"
    HSerPrintCRLF
    dim ccount_int as Byte 'integer byte

    'Factored the 4.5 x 10 larger
    ccount_int   = 45

    For  multiplier = 0 to 40000 step 2500

      'Do some maths... multiplier x ccount
      result = multiplier * ccount_int

      HSerPrint "45"
      HSerPrint " x "
      HSerPrint left(str32(multiplier)+"        ", 8 )
      HSerPrint " = "

      HSerPrint left(str32(result)+"        ", 8 )

      'Now do the scale maths - this can all be done in integer maths
      HSerPrint " scaled result = "

      'Factored calculation is 10 x larger
      result = 180-(result/10000)
      HSerPrint Result
      HSerPrintCRLF
      wait 100 ms

    next

To check variables and apply logic based on their value, see If, Do, For, Conditions

For more help, see: Declaring variables with DIM, Setting Variables