Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[skip-ci] Update ttree doc #11847

Merged
merged 7 commits into from
Mar 1, 2023
Merged

[skip-ci] Update ttree doc #11847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9249cdd
[skip-ci] Update ttree doc
couet Dec 7, 2022
7dc2aaa
more changes
couet Dec 7, 2022
87d530a
change the place of the addon
couet Dec 7, 2022
0ca9f04
more mods
couet Dec 7, 2022
26df77b
Update tree/tree/src/TBranch.cxx
couet Feb 21, 2023
c673ff2
Update tree/tree/src/TTree.cxx
couet Feb 21, 2023
d3becc3
Update tree/tree/src/TTree.cxx
couet Feb 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions tree/tree/src/TBranch.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ TBranch::TBranch()
/// assumed of type F by default. The list of currently supported
/// types is given below:
/// - `C` : a character string terminated by the 0 character
/// - `B` : an 8 bit signed integer (`Char_t`)
/// - `B` : an 8 bit signed integer (`Char_t`); Treated as a character when in an array.
/// - `b` : an 8 bit unsigned integer (`UChar_t`)
/// - `S` : a 16 bit signed integer (`Short_t`)
/// - `s` : a 16 bit unsigned integer (`UShort_t`)
Expand Down Expand Up @@ -1897,7 +1897,7 @@ TBasket *TBranch::GetFreshCluster(TBuffer* user_buffer)
if (fExtraBasket) {
newbasket = fExtraBasket;
fExtraBasket = nullptr;
} else {
} else {
newbasket = fTree->CreateBasket(this);
}
if (user_buffer)
Expand Down
14 changes: 8 additions & 6 deletions tree/tree/src/TTree.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ It is strongly recommended to persistify those as objects rather than lists of l
assumed of type F by default. The list of currently supported
types is given below:
- `C` : a character string terminated by the 0 character
- `B` : an 8 bit signed integer (`Char_t`)
- `b` : an 8 bit unsigned integer (`UChar_t`)
/// - `B` : an 8 bit signed integer (`Char_t`); Treated as a character when in an array.
/// - `b` : an 8 bit unsigned integer (`UChar_t`)
- `S` : a 16 bit signed integer (`Short_t`)
- `s` : a 16 bit unsigned integer (`UShort_t`)
- `I` : a 32 bit signed integer (`Int_t`)
Expand All @@ -110,6 +110,7 @@ It is strongly recommended to persistify those as objects rather than lists of l
- A float array with fixed size: "myArrfloat[42]/F"
- An double array with variable size, held by the `myvar` column: "myArrdouble[myvar]/D"
- An Double32_t array with variable size, held by the `myvar` column , with values between 0 and 16: "myArr[myvar]/d[0,10]"
- The `myvar` column, which holds the variable size, **MUST** be an `Int_t` (/I).

- If the address points to a single numerical variable, the leaflist is optional:
~~~ {.cpp}
Expand All @@ -124,8 +125,8 @@ It is strongly recommended to persistify those as objects rather than lists of l
- In case of the truncated floating point types (Float16_t and Double32_t) you can
furthermore specify the range in the style [xmin,xmax] or [xmin,xmax,nbits] after
the type character. For example, for storing a variable size array `myArr` of
`Double32_t` with values within a range of `[0, 2*pi]` and the size of which is
stored in a branch called `myArrSize`, the syntax for the `leaflist` string would
`Double32_t` with values within a range of `[0, 2*pi]` and the size of which is stored
in an `Int_t` (/I) branch called `myArrSize`, the syntax for the `leaflist` string would
be: `myArr[myArrSize]/d[0,twopi]`. Of course the number of bits could be specified,
the standard rules of opaque typedefs annotation are valid. For example, if only
18 bits were sufficient, the syntax would become: `myArr[myArrSize]/d[0,twopi,18]`
Expand Down Expand Up @@ -1938,8 +1939,8 @@ Int_t TTree::Branch(const char* foldername, Int_t bufsize /* = 32000 */, Int_t s
/// variable. If the first variable does not have a type, it is assumed
/// of type F by default. The list of currently supported types is given below:
/// - `C` : a character string terminated by the 0 character
/// - `B` : an 8 bit signed integer (`Char_t`)
/// - `b` : an 8 bit unsigned integer (`UChar_t`)
/// - `B` : an 8 bit signed integer (`Char_t`); Treated as a character when in an array.
/// - `b` : an 8 bit unsigned integer (`UChar_t`)
/// - `S` : a 16 bit signed integer (`Short_t`)
/// - `s` : a 16 bit unsigned integer (`UShort_t`)
/// - `I` : a 32 bit signed integer (`Int_t`)
Expand All @@ -1958,6 +1959,7 @@ Int_t TTree::Branch(const char* foldername, Int_t bufsize /* = 32000 */, Int_t s
/// - If leaf name has the form var[nelem], where nelem is alphanumeric, then
/// if nelem is a leaf name, it is used as the variable size of the array,
/// otherwise return 0.
/// The leaf referred to by nelem **MUST** be an int (/I),
/// - If leaf name has the form var[nelem], where nelem is a non-negative integer, then
/// it is used as the fixed size of the array.
/// - If leaf name has the form of a multi-dimensional array (e.g. var[nelem][nelem2])
Expand Down