@@ -1770,11 +1770,38 @@ def date(self):
1770
1770
1771
1771
def normalize (self ):
1772
1772
"""
1773
- Return DatetimeIndex with times to midnight. Length is unaltered
1773
+ Return DatetimeIndex with times converted to midnight.
1774
+
1775
+ When using DatetimeIndex, the time can be converted to midnight i.e.
1776
+ 00:00:00. This is useful in cases, when the time does not matter.
1777
+ Length is unaltered. The timezones are unaffected. If the frequency
1778
+ is 'H','min' or 'S' it changes to None otherwise it remains
1779
+ unaffected.
1774
1780
1775
1781
Returns
1776
1782
-------
1777
1783
normalized : DatetimeIndex
1784
+
1785
+ See Also
1786
+ --------
1787
+ DatetimeIndex.floor : Floor the DatetimeIndex to the specified freq.
1788
+ DatetimeIndex.ceil : Ceil the DatetimeIndex to the specified freq.
1789
+ DatetimeIndex.round : Round the DatetimeIndex to the specified freq.
1790
+
1791
+ Examples
1792
+ --------
1793
+ >>> df = pd.DatetimeIndex(start='2014-08-01 10:00', freq='H',
1794
+ ... periods=3, tz='Asia/Calcutta')
1795
+ >>> df
1796
+ DatetimeIndex(['2014-08-01 10:00:00+05:30',
1797
+ '2014-08-01 11:00:00+05:30',
1798
+ '2014-08-01 12:00:00+05:30'],
1799
+ dtype='datetime64[ns, Asia/Calcutta]', freq='H')
1800
+ >>> df.normalize()
1801
+ DatetimeIndex(['2014-08-01 00:00:00+05:30',
1802
+ '2014-08-01 00:00:00+05:30',
1803
+ '2014-08-01 00:00:00+05:30'],
1804
+ dtype='datetime64[ns, Asia/Calcutta]', freq=None)
1778
1805
"""
1779
1806
new_values = conversion .date_normalize (self .asi8 , self .tz )
1780
1807
return DatetimeIndex (new_values , freq = 'infer' , name = self .name ,
0 commit comments