# ***********************************************
# 
# !!!! DO NOT EDIT !!!!
# 
# This file was auto-generated by Build.PL.
# 
# ***********************************************
# 
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
# 
#     http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

=encoding utf8

=head1 NAME

Lucy::Analysis::CaseFolder - Normalize case, facilitating case-insensitive search.

=head1 SYNOPSIS

    my $case_folder = Lucy::Analysis::CaseFolder->new;

    my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new(
        analyzers => [ $tokenizer, $case_folder, $stemmer ],
    );

=head1 DESCRIPTION

CaseFolder is DEPRECATED. Use L<Normalizer|Lucy::Analysis::Normalizer>
instead.

CaseFolder normalizes text according to Unicode case-folding rules, so that
searches will be case-insensitive.

=head1 CONSTRUCTORS

=head2 new

    my $case_folder = Lucy::Analysis::CaseFolder->new;

Constructor.  Takes no arguments.

=head1 METHODS

=head2 transform

    my $inversion = $case_folder->transform($inversion);

Take a single L<Inversion|Lucy::Analysis::Inversion> as input
and returns an Inversion, either the same one (presumably transformed
in some way), or a new one.

=over

=item *

B<inversion> - An inversion.

=back

=head1 INHERITANCE

Lucy::Analysis::CaseFolder isa L<Lucy::Analysis::Analyzer> isa Clownfish::Obj.

=cut