Add bar function #5993

papparapa · 2023-01-25T14:45:09Z

This PR adds BAR function like ClickHouse's BAR function.

It draws unicode-art bar chart and is useful for instant visualization of numerical data in CLI.

bar(x, min, max, width) draws a band with a width proportional to (x - min) and equal to width characters when x = max.

Arguments

x — Size to display.

min, max — Integer constants. The value must fit in Int64.

width — Constant, positive integer, can be fractional.

The band is drawn with accuracy to one eighth of a symbol.

e.g.

D select x * x as y, bar(y, 0, 100) from range(0, 11) _(x);
┌───────┬──────────────────────────────────────────────────────────────────────────────────┐
│   y   │                                  bar(y, 0, 100)                                  │
│ int64 │                                     varchar                                      │
├───────┼──────────────────────────────────────────────────────────────────────────────────┤
│     0 │                                                                                  │
│     1 │ ▊                                                                                │
│     4 │ ███▏                                                                             │
│     9 │ ███████▏                                                                         │
│    16 │ ████████████▊                                                                    │
│    25 │ ████████████████████                                                             │
│    36 │ ████████████████████████████▊                                                    │
│    49 │ ███████████████████████████████████████▏                                         │
│    64 │ ███████████████████████████████████████████████████▏                             │
│    81 │ ████████████████████████████████████████████████████████████████▊                │
│   100 │ ████████████████████████████████████████████████████████████████████████████████ │
├───────┴──────────────────────────────────────────────────────────────────────────────────┤
│ 11 rows                                                                        2 columns │
└──────────────────────────────────────────────────────────────────────────────────────────┘

Two overloads are included.

BAR(x: double, min: double, max: double)
BAR(x: double, min: double, max: double, width: double)

In the former overload, width is set to 80 implicitly.

Mytherin

Thanks for the PR! Looks good. Some comments below:

src/function/scalar/string/bar.cpp

src/include/duckdb/common/vector_operations/quaternary_executor.hpp

papparapa · 2023-01-27T03:34:31Z

Also fixed a bug in GenericExecutor.
Constant vector check in GenericExecutor::ExecuteTernaryInternal and GenericExecutor::ExecuteQuaternaryInternal missed vectors except for the first and second ones.

Mytherin

Thanks for the fixes! Looks good - some more minor comments:

Mytherin · 2023-01-27T13:17:46Z

src/function/scalar/string/bar.cpp

+	static const char *FULL_BLOCK = UnicodeBar::FullBlock();
+	static const char *const *PARTIAL_BLOCKS = UnicodeBar::PartialBlocks();
+	static const idx_t PARTIAL_BLOCKS_COUNT = UnicodeBar::PartialBlocksCount();
+	static const idx_t UNICODE_BLOCK_CHAR_SIZE = strlen(FULL_BLOCK);


This won't work for the space character, no? As it is only a single byte.

Removed UNICODE_BLOCK_CHAR_SIZE

Mytherin · 2023-01-27T13:18:32Z

src/function/scalar/string/bar.cpp

+	int32_t width_as_int = static_cast<int32_t>(width * PARTIAL_BLOCKS_COUNT);
+	idx_t full_blocks_count = (width_as_int / PARTIAL_BLOCKS_COUNT);
+	for (idx_t i = 0; i < full_blocks_count; i++) {
+		result.insert(result.end(), FULL_BLOCK, FULL_BLOCK + UNICODE_BLOCK_CHAR_SIZE);


Do we need this to be a vector<char>? Can this not be a std::string instead? It seems like that would simplify the code, as we could then just use string appends (e.g. result += FULL_BLOCK;). Then we wouldn't need UNICODE_BLOCK_CHAR_SIZE either.

That's right.
Fixed to use string

…r-function

Mytherin · 2023-02-02T21:59:44Z

Thanks for the changes! Looks good.

papparapa added 3 commits January 25, 2023 10:53

Add bar function

b6776da

Add test case of bar function

18ce7e1

Fix typo in header file

980eae8

Mytherin reviewed Jan 26, 2023

View reviewed changes

src/function/scalar/string/bar.cpp Show resolved Hide resolved

src/function/scalar/string/bar.cpp Outdated Show resolved Hide resolved

src/include/duckdb/common/vector_operations/quaternary_executor.hpp Outdated Show resolved Hide resolved

papparapa added 6 commits January 27, 2023 00:52

Fix the commented points

88d0594

Remove quaternary_executor.hpp

0d880c3

Add static specifier to member variables

3c6f816

Add test cases of bar function

34f526f

Fix constant check bug in GegericExecutor

fe3f395

Fix test of bar function

4507cb3

Mytherin reviewed Jan 27, 2023

View reviewed changes

papparapa added 5 commits January 27, 2023 14:30

Fix to use string instead of vector<char>

b78a3a2

Fix to use reference

f2f971a

Merge branch 'master' of https://github.com/duckdb/duckdb into add-ba…

fbac792

…r-function

Merge branch 'master' of https://github.com/duckdb/duckdb into add-ba…

396bd0f

…r-function

Merge branch 'master' of https://github.com/duckdb/duckdb into add-ba…

b3735a9

…r-function

Mytherin merged commit e2cacf2 into duckdb:master Feb 2, 2023

papparapa deleted the add-bar-function branch February 3, 2023 12:23

papparapa mentioned this pull request Feb 8, 2023

Add bar function docs duckdb/duckdb-web#529

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add bar function #5993

Add bar function #5993

papparapa commented Jan 25, 2023

Uh oh!

Mytherin left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

papparapa commented Jan 27, 2023

Uh oh!

Mytherin left a comment

Uh oh!

Mytherin Jan 27, 2023

Uh oh!

papparapa Jan 27, 2023

Uh oh!

Mytherin Jan 27, 2023 •

edited

Loading

Uh oh!

papparapa Jan 27, 2023

Uh oh!

Mytherin commented Feb 2, 2023

Uh oh!

Uh oh!

Add bar function #5993

Add bar function #5993

Conversation

papparapa commented Jan 25, 2023

Uh oh!

Mytherin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

papparapa commented Jan 27, 2023

Uh oh!

Mytherin left a comment

Choose a reason for hiding this comment

Uh oh!

Mytherin Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

papparapa Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

Mytherin Jan 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

papparapa Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

Mytherin commented Feb 2, 2023

Uh oh!

Uh oh!

Mytherin Jan 27, 2023 •

edited

Loading