Skip to content

Rdfd print adjusted #9105

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

Merged
eguiraud merged 2 commits into from
Oct 13, 2021
Merged

Rdfd print adjusted #9105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1c4392
[Fix #6981] RDisplay::Print to list custom number of elements from c…
ikabadzhov Oct 12, 2021
1a8a4ef
Apply suggestions from code review
ikabadzhov Oct 13, 2021
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: 3 additions & 1 deletion tree/dataframe/inc/ROOT/RDF/RDisplay.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ private:

size_t fEntries; ///< Number of events to process for each column (i.e. number of rows).

size_t fNMaxCollectionElements = 10; // threshold on number of elements in collections to be Print()

////////////////////////////////////////////////////////////////////////////
/// Appends a cling::printValue call to the stringstream.
/// \tparam T the type of the event to convert
Expand Down Expand Up @@ -234,7 +236,7 @@ public:
/// \param[in] columnNames Columns to print
/// \param[in] types The type of each column
/// \param[in] entries How many events per column (row) must be processed.
RDisplay(const VecStr_t &columnNames, const VecStr_t &types, int entries);
RDisplay(const VecStr_t &columnNames, const VecStr_t &types, int entries, size_t nMaxCollectionElements);

////////////////////////////////////////////////////////////////////////////
/// Prints the representation to the standard output
Expand Down
28 changes: 19 additions & 9 deletions tree/dataframe/inc/ROOT/RDF/RInterface.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2566,13 +2566,15 @@ public:
/// \tparam ColumnTypes variadic list of branch/column types.
/// \param[in] columnList Names of the columns to be displayed.
/// \param[in] nRows Number of events for each column to be displayed.
/// \param[in] nMaxCollectionElements Maximum number of collection elements to display per row.
/// \return the `RDisplay` instance wrapped in a RResultPtr.
///
/// This function returns a RResultPtr<RDisplay>` containing all the entries to be displayed, organized in a tabular
/// form. RDisplay will either print on the standard output a summarized version through `Print()` or will return a
/// complete version through `AsString()`.
///
/// This action is *lazy*: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
/// This action is *lazy*: upon invocation of this method the calculation is booked but not executed. Also see
/// RResultPtr.
///
/// Example usage:
/// ~~~{.cpp}
Expand All @@ -2585,26 +2587,31 @@ public:
/// d2->Print();
/// ~~~
template <typename... ColumnTypes>
RResultPtr<RDisplay> Display(const ColumnNames_t &columnList, const int &nRows = 5)
RResultPtr<RDisplay>
Display(const ColumnNames_t &columnList, int nRows = 5, size_t nMaxCollectionElements = 10)
{
CheckIMTDisabled("Display");

auto displayer = std::make_shared<RDFInternal::RDisplay>(columnList, GetColumnTypeNamesList(columnList), nRows);
auto displayer = std::make_shared<RDFInternal::RDisplay>(columnList, GetColumnTypeNamesList(columnList), nRows,
nMaxCollectionElements);
return CreateAction<RDFInternal::ActionTags::Display, ColumnTypes...>(columnList, displayer, displayer);
}

////////////////////////////////////////////////////////////////////////////
/// \brief Provides a representation of the columns in the dataset.
/// \param[in] columnList Names of the columns to be displayed.
/// \param[in] nRows Number of events for each column to be displayed.
/// \param[in] nMaxCollectionElements Maximum number of collection elements to display per row.
/// \return the `RDisplay` instance wrapped in a RResultPtr.
///
/// This overload automatically infers the column types.
/// See the previous overloads for further details.
RResultPtr<RDisplay> Display(const ColumnNames_t &columnList, const int &nRows = 5)
RResultPtr<RDisplay>
Display(const ColumnNames_t &columnList, int nRows = 5, size_t nMaxCollectionElements = 10)
{
CheckIMTDisabled("Display");
auto displayer = std::make_shared<RDFInternal::RDisplay>(columnList, GetColumnTypeNamesList(columnList), nRows);
auto displayer = std::make_shared<RDFInternal::RDisplay>(columnList, GetColumnTypeNamesList(columnList), nRows,
nMaxCollectionElements);
return CreateAction<RDFInternal::ActionTags::Display, RDFDetail::RInferredType>(columnList, displayer, displayer,
columnList.size());
}
Expand All @@ -2613,16 +2620,18 @@ public:
/// \brief Provides a representation of the columns in the dataset.
/// \param[in] columnNameRegexp A regular expression to select the columns.
/// \param[in] nRows Number of events for each column to be displayed.
/// \param[in] nMaxCollectionElements Maximum number of collection elements to display per row.
/// \return the `RDisplay` instance wrapped in a RResultPtr.
///
/// The existing columns are matched against the regular expression. If the string provided
/// is empty, all columns are selected.
/// See the previous overloads for further details.
RResultPtr<RDisplay> Display(std::string_view columnNameRegexp = "", const int &nRows = 5)
RResultPtr<RDisplay>
Display(std::string_view columnNameRegexp = "", int nRows = 5, size_t nMaxCollectionElements = 10)
{
const auto columnNames = GetColumnNames();
const auto selectedColumns = RDFInternal::ConvertRegexToColumns(columnNames, columnNameRegexp, "Display");
return Display(selectedColumns, nRows);
return Display(selectedColumns, nRows, nMaxCollectionElements);
}

////////////////////////////////////////////////////////////////////////////
Expand All @@ -2632,10 +2641,11 @@ public:
/// \return the `RDisplay` instance wrapped in a RResultPtr.
///
/// See the previous overloads for further details.
RResultPtr<RDisplay> Display(std::initializer_list<std::string> columnList, const int &nRows = 5)
RResultPtr<RDisplay> Display(std::initializer_list<std::string> columnList, int nRows = 5,
size_t nMaxCollectionElements = 10)
{
ColumnNames_t selectedColumns(columnList);
return Display(selectedColumns, nRows);
return Display(selectedColumns, nRows, nMaxCollectionElements);
}

private:
Expand Down
37 changes: 12 additions & 25 deletions tree/dataframe/src/RDFDisplay.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,14 +135,14 @@ void RDisplay::AddCollectionToRow(const std::vector<std::string> &collection)
// Update the width if this element is the biggest found
EnsureCurrentColumnWidth(stringEle.length());

if (index == 0 || index == collectionSize - 1) {
if (index < fNMaxCollectionElements) {
// Do nothing, by default DisplayElement is printed
} else if (index == 1) {
} else if (index == fNMaxCollectionElements) {
element.SetDots();
// Be sure the "..." fit
EnsureCurrentColumnWidth(3);
} else {
// In the Print(), after the dots, all element will just be ignored except the last one.
// In the Print(), after the dots, all element will just be ignored.
element.SetIgnore();
}

Expand Down Expand Up @@ -172,11 +172,11 @@ void RDisplay::MovePosition()
}
}

RDisplay::RDisplay(const VecStr_t &columnNames, const VecStr_t &types, int entries)
RDisplay::RDisplay(const VecStr_t &columnNames, const VecStr_t &types, int entries, size_t nMaxCollectionElements)
: fTypes(types), fWidths(columnNames.size(), 0), fRepresentations(columnNames.size()),
fCollectionsRepresentations(columnNames.size()), fNColumns(columnNames.size()), fEntries(entries)
fCollectionsRepresentations(columnNames.size()), fNColumns(columnNames.size()), fEntries(entries),
fNMaxCollectionElements(nMaxCollectionElements)
{

// Add the first row with the names of the columns
fTable.push_back(std::vector<DElement_t>(columnNames.size()));
for (const auto &name : columnNames) {
Expand All @@ -203,14 +203,15 @@ void RDisplay::Print() const
{
auto columnsToPrint =
fNColumns - GetNColumnsToShorten(); // Get the number of columns that fit in the characters limit
std::vector<bool> hasPrintedNext(fNColumns,
false); // Keeps track if the collection as already been shortened, allowing to skip
// all elements until the next printable element.

if (columnsToPrint < fNColumns)
Info("Print", "Only showing %lu columns out of %lu\n", columnsToPrint, fNColumns);

if (fNMaxCollectionElements < 1)
Info("Print", "No collections shown since fNMaxCollectionElements is %lu\n", fNMaxCollectionElements);

auto nrRows = fTable.size();

for (size_t rowIndex = 0; rowIndex < nrRows; ++rowIndex) {
auto &row = fTable[rowIndex];

Expand All @@ -224,23 +225,9 @@ void RDisplay::Print() const
if (element.IsDot()) {
printedElement = "...";
} else if (element.IsPrint()) {
// Maybe the element is part of a collection that is being shortened, and so it was already printed.
if (!hasPrintedNext[columnIndex]) {
printedElement = element.GetRepresentation();
}
hasPrintedNext[columnIndex] =
false; // Encountered "next printable element", shortening can start again when needed.
printedElement = element.GetRepresentation();
} else { // IsIgnore
// Shortening is starting here. Print directly the last element, to have something like 1 ... 3, and don't
// print anything else.
if (!hasPrintedNext[columnIndex]) {
size_t i = rowIndex + 1; // Starting from the next row...
for (; !fTable[i][columnIndex].IsPrint(); ++i) {
// .. look for the first element that can be printed, it will be the last of the collection.
}
printedElement = fTable[i][columnIndex].GetRepresentation(); // Print the element
hasPrintedNext[columnIndex] = true; // And start ignoring anything else until the next collection.
}
// Do nothing, printedElement remains ""
}
if (!printedElement.empty()) {
// Found at least one element, so the row is not empty.
Expand Down
Loading