|
PureBytes Links
Trading Reference Links
|
Sounds good to me.
Joseph Biran
____________________________________________
From:
amibroker@xxxxxxxxxxxxxxx [mailto:amibroker@xxxxxxxxxxxxxxx] On Behalf Of Dennis
Brown
Sent: Wednesday, September 24, 2008 9:35 AM
To: amibroker@xxxxxxxxxxxxxxx
Subject: Re: [amibroker] AmiBroker AFL Glossary project --LIFT OFF
Joseph,
(Tomasz, please correct any factual errors or omissions in
this post)
Ok, It percolated for a while and this is what I came up
with. Array types imply single numbers as a subset of an array. It
is therefore redundant to specify for instance that a type can be an array of
numbers or a number. However, a type may be a number only and not an
array. This leads me to the conclusion that I was in error to have a
generic array type. Here is a proposed legend for the return types we
currently have: (Please correct me if I am wrong)
n = single IEEE 32 bit floating point number only
N = Array of floating point numbers (including a single
number)
b = single boolean number only (for parameters: False =
0 or null / True = not false), (for returns: False = 0 / True = 1)
B = Array of boolean numbers (including a
single boolean number)
s = a single string of UTF 8 bit ASCII characters (max
length?)
There are different ways to "interpret" a floating
point number of course as in boolean above.
We have the sign + 23 bit pseudo integers
3 x 8 bit positive integer "Color"
32 bit "Binary" for binary operations like &,
|
Perhaps we should specify these interpretations also:
-- The following would be a nomenclature conflict with
boolean type that needs resolution. L,l for logic won't work.
b = bitwise binary number
-- The results are still interpreted as a float for
everything, except the &,| operator actions. Perhaps we don't need
more than N,n for this
I am thinking that these basic
type nomenclatures would be used in the glossary database template,
but what is generated for document output could be anything of course. It
would take me less time to fix the doc generator than it took to write this
post. LOL
On Sep 24, 2008, at 8:25 AM, Dennis Brown wrote:
Joseph,
Thanks for the suggestion. I will let it percolate on
my brain a bit. Of course, if it gets to cryptic, it defeats the purpose.
The &nb!
sp; in the example is not my doing. That is something thrown in by
Yahoo or a mail program. I think it is some BB or HTML formatting for a !
which is also not my doing. I see that these errors are creeping in with
each successive reply, but not the original.
I see the odd space and
formatting error now and then show up in replies.
On Sep 24, 2008, at 3:33 AM, J. Biran wrote:
I think this strongly depends on individual taste and has no
absolute correct answer.
The returned values is of significant importance and is good it
stands out. It could also be placed right before the AB version info.
You could also borrow from the convention that units of measure
are placed in square brackets (i.e. [sec]) and use [n] or [s], [b], [A(n)],
[A(b)], [A(s)] etc… (A = Array).
I just noticed &nb! sp in your example
below. Was it there before? Is this some formatting info? Also what is the !
for?
Joseph Biran
____________________________________________
I see your point. I just
made up some conventions to test it out. It could be formatted any number of ways. In fact
I am busy writing the sorting and filtering routines. Let me
know if you have a good idea for an alternative way to format the output and I
can throw that in at the same time.
Another one is I
have "a" for array "a|n" for array or number, and
"b" for boolean. It occurs to me the I should also have "a|b" for a boolean array
or a boolean number. that would also be the result type for things like
comparison operators. Operators will be another whole class of formats in the
template.
As we expand the
glossary to more than just functions, I am sure additional considerations will
have to be made in the database template and report generation formats to accommodate these. In some construct it is a statement that is the parameter
like in a for(initialStatement; booleanExit; loopStatement){}.
These will take
some additional thought. We need to fill in all the AFL functions though, and that
will take a little while and is actually the easy part because we have the AB
functions list to get us started.
On Sep 23, 2008,
at 8:32 PM, J. Biran wrote:
Also, distinguishing array from number would be beneficial.
Joseph Biran
____________________________________________
Good question. I had
selected a parameter to show return value types in the sample output. The n is
a number type returned by the function. Other types are: s is a string, a is an ar! ray, b i s
Boolean number
(True/False) etc., as shown in the template. I could have selected to output a descriptive name instead, or nothing. There
are a number of variations on a basic theme.
On Sep 23, 2008,
at 6:09 PM, J. Biran wrote:
What is the n = stand for?
Joseph Biran
____________________________________________
I have uploaded
to the AFL Library a program called AF_Glossary_Generator (yes a typo in the
name) that takes another file uploaded called AFL_Glossary_1 and generates
parameter selectable formatted TXT or RTF files for this
project. It took me a couple of hours to make a database file for
all the string manipulation functions, and forever to make the program
that spit out formatted documents. Creating the files for both forced me to
refine the database specification a bit further.
Please download
them both and try them out. You have to create a directory called AFL_Glossary in your
main AmiBroker folder and put the file named AFL_Glossary_1.txt into it. Rename
the file to strip off the .afl and make sure it ends in .txt. The
output files will be written to the same folder. On a PC,
the .txt and .rtf files read fine in WordPad, but the links don't work in that
program. They do work in Word. In the Mac, all formats w! ork fine in TextEdit program.
Please download
the program and data and give me some feedback. Sorry
there are not a lot of instructions, but you just select parameters, and click
on the Convert Database button to get something written out. You can
try out all kinds of different formats.
Next, we need
volunteers to write small sections of the database to make headway. If you
make another file called AFL_Glossary_2.txt, etc., it w! ill comb
ine them into one database for outputs.
PS. here is a
sample of one possible output:
AFL -- AmiBroker Formula Language
-- Abbreviation for AmiBroker
Formula Language
-- See Also: AmiBroker Formula Language
n = &nb!
sp; ; Asc( String,
CharacterPosition=0 ) [AB 4.8] -- get ASCII code of character
-- Returns the ASCII code
number for a text character
-- Group Tags: AFL,Functions,String
manipulation,Type Conversions
-- Search Tags: ASCII,character,convert,code
n = StrToDateTime(
DateTimeText ) [AB 4.8] -- convert string to datetime
-- Returns datetime number from
a text representation of the Date/Time
-- Group Tags: AFL,Functions,String
manipulation,Type Conversions,Date and Time
! -- Search Tags: datetime,date,time,convert
-- See
Also: DateTimeToStr(),Now(),DateTime(),TimeNum(),Date()
The rtf file of the whole sample output is also attached here for
those who get individual emails:
__._,_.___
Please note that this group is for discussion between users only.
To get support from AmiBroker please send an e-mail directly to
SUPPORT {at} amibroker.com
For NEW RELEASE ANNOUNCEMENTS and other news always check DEVLOG:
http://www.amibroker.com/devlog/
For other support material please check also:
http://www.amibroker.com/support.html
![]()
__,_._,___
|
|