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.

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

New zfill function to left-pad a string with zeros #689

Merged
merged 2 commits into from
Mar 3, 2023

Conversation

ecasglez
Copy link
Contributor

Adds a zfill function to left-pad a string with zeros. I have implemented it becuase I think it is a simple but useful function.

This would close issue #394.

It consists on an interface zfill pointing to functions zfill_string and zfill_char to use it with strings and chars respectively. The implementation is equivalent to the one in functions padl_string_default and padl_char_default.

I have prepared the documentation, examples and tests. I think I haven't miss anything but feel free to tell me so I can make any correction.

@14NGiestas 14NGiestas linked an issue Dec 22, 2022 that may be closed by this pull request
@milancurcic
Copy link
Member

Thank you @ecasglez for this PR. I'll review and test it.

@milancurcic milancurcic added enhancement New feature or request topic: strings String processing labels Jan 5, 2023
@urbanjost
Copy link

I have a zero padding function and thought I would just mention some of the possibly different behaviors for consideration. In some cases I am not sure what this one does yet, but even if the same they might be points to consider (I hope to try this one soon, but have not yet):

o allow integer input arguments as well as strings?
o should the input string be cropped and then padded or should it retain original right-hand spaces?
o does it handle signed values by moving the sign to the beginning of the string?
o should the length be optional, in which case it defaults to the length of input string when the input is a string?

Not saying it should behave one way or the other, but if not already described, the documentation should make sure to clarify the behavior, based on the experience I had with something similar.

I did not get permission to make another one public, but in addition to left, right, center, and zero padding one other padding function I have found useful is to pad "numeric" strings so that the decimal character is lined up.

Copy link
Member

@milancurcic milancurcic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, I think this is good to go, I'll just re-run the CI just in case.

doc/specs/stdlib_strings.md Outdated Show resolved Hide resolved
@milancurcic
Copy link
Member

Thanks, @urbanjost, for all these ideas. Here's my opinion:

o allow integer input arguments as well as strings?

I don't think so, we already have solid capability to go from an integer to string, so I think zfill(string_type(123)) is a decent solution for this.

o should the input string be cropped and then padded or should it retain original right-hand spaces?
o does it handle signed values by moving the sign to the beginning of the string?

IMO, I don't think so, to keep the behavior simple, and I think the current description is appropriate in this regard (i.e. we describe what the function does, but not what it doesn't do).

o should the length be optional, in which case it defaults to the length of input string when the input is a string?

I think that would be a good addition, let's evaluate it for a separate PR. I'll open an issue.

@milancurcic milancurcic merged commit 8f7ac8d into fortran-lang:master Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request topic: strings String processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Function to pad string with zeros
3 participants