/usr/lib/swipl/library/isub.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl -- Error generating support
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl -- Print debug messages and test assertions
      • broadcast.pl -- Event service
      • socket.pl -- Network socket (TCP and UDP) library
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • uid.pl -- User and group management on Unix systems
      • unix.pl -- Unix specific operations
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • record.pl -- Access compound arguments by name
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • uri.pl -- Process URIs
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • yall.pl -- Lambda expressions
      • sha.pl -- SHA secure hashes
      • process.pl -- Create processes and redirect I/O
      • filesex.pl -- Extended operations on files
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • modules.pl -- Module utility predicates
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl -- Prolog syntax colouring support.
      • lazy_lists.pl -- Lazy list handling
      • prolog_code.pl -- Utilities for reasoning about code
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • doc_http.pl -- Documentation server
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • git.pl -- Run GIT commands
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • crypt.pl
      • dialect.pl -- Support multiple Prolog dialects
      • persistency.pl -- Provide persistent dynamic predicates
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • listing.pl -- List programs and pretty print clauses
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • nb_set.pl -- Non-backtrackable sets
      • sgml_write.pl -- XML/SGML writer module
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • backcomp.pl -- Backward compatibility
      • redis.pl -- Redis client
      • system.pl -- System utilities
      • heaps.pl -- heaps/priority queues
      • check.pl -- Consistency checking
      • odbc.pl
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf.pl -- RDF/XML parser
      • rdf_parser.pl
      • rewrite_term.pl
      • shell.pl -- Elementary shell commands
      • pwp.pl -- Prolog Well-formed Pages
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • tables.pl -- XSB interface to tables
      • base32.pl -- Base32 encoding and decoding
      • charsio.pl -- I/O on Lists of Character Codes
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • date.pl -- Process dates and times
      • rbtrees.pl -- Red black trees
      • statistics.pl -- Get information about resource usage
      • when.pl -- Conditional coroutining
      • streampool.pl -- Input multiplexing
      • stomp.pl -- STOMP client.
      • hashtable.pl -- Hash tables
      • archive.pl -- Access several archive formats
      • edit.pl -- Editor interface
      • quintus.pl -- Quintus compatibility
      • explain.pl -- Describe Prolog Terms
      • writef.pl -- Old-style formatted write
      • portray_text.pl -- Portray text
      • unicode.pl -- Unicode string handling
      • make.pl -- Reload modified source files
      • optparse.pl -- command line parsing
      • thread.pl -- High level thread primitives
      • threadutil.pl -- Interactive thread utilities
      • editline.pl -- BSD libedit based command line editing
      • prolog_debug.pl -- User level debugging tools
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_wrap.pl -- Wrapping predicates
      • prolog_trace.pl -- Print access to predicates
      • doc_latex.pl -- PlDoc LaTeX backend
      • prolog_autoload.pl -- Autoload all dependencies
      • oset.pl -- Ordered set manipulation
      • plunit.pl -- Unit Testing
      • intercept.pl -- Intercept and signal interface
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • c14n2.pl -- C14n2 canonical XML documents
      • paxos.pl -- A Replicated Data Store
      • udp_broadcast.pl -- A UDP broadcast proxy
      • table.pl
      • xsdp_types.pl -- XML-Schema primitive types
      • double_metaphone.pl -- Phonetic string matching
      • files.pl
      • test_cover.pl -- Clause coverage analysis
      • help.pl -- Text based manual
      • redis_streams.pl -- Using Redis streams
      • mqi.pl
      • term_to_json.pl
      • yaml.pl -- Process YAML data
      • fastrw.pl -- Fast reading and writing of terms
      • rlimit.pl
      • isub.pl -- isub: a string similarity measure
        • isub/4
      • cgi.pl -- Read CGI parameters
      • readline.pl -- GNU readline interface
      • xmlenc.pl -- XML encryption library
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • increval.pl -- Incremental dynamic predicate modification
      • doc_files.pl -- Create stand-alone documentation files
      • prolog_stream.pl -- A stream with Prolog callbacks
      • xmldsig.pl -- XML Digital signature
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_versions.pl -- Demand specific Prolog versions
 isub(+Text1:text, +Text2:text, -Similarity:float, +Options:list) is det
Similarity is a measure of the similarity/dissimilarity between Text1 and Text2. E.g.
?- isub('E56.Language', 'languange', D, [normalize(true)]).
D = 0.4226950354609929.                       % [-1,1] range

?- isub('E56.Language', 'languange', D, [normalize(true),zero_to_one(true)]).
D = 0.7113475177304964.                       % [0,1] range

?- isub('E56.Language', 'languange', D, []).  % without normalization
D = 0.19047619047619047.                      % [-1,1] range

?- isub(aa, aa, D, []).  % does not work for short substrings
D = -0.8.

?- isub(aa, aa, D, [substring_threshold(0)]). % works with short substrings
D = 1.0.                                      % but may give unwanted values
                                              % between e.g. 'store' and 'spore'.

?- isub(joe, hoe, D, [substring_threshold(0)]).
D = 0.5315315315315314.

?- isub(joe, hoe, D, []).
D = -1.0.

This is a new version of isub/4 which replaces the old version while providing backwards compatibility. This new version allows several options to tweak the algorithm.

Arguments:
Text1- and Text2 are either an atom, string or a list of characters or character codes.
Similarity- is a float in the range [-1,1.0], where 1.0 means most similar. The range can be set to [0,1] with the zero_to_one option described below.
Options- is a list with elements described below. Please note that the options are processed at compile time using goal_expansion to provide much better speed. Supported options are:
normalize(+Boolean)
Applies string normalization as implemented by the original authors: Text1 and Text2 are mapped to lowercase and the characters "._ " are removed. Lowercase mapping is done with the C-library function towlower(). In general, the required normalization is domain dependent and is better left to the caller. See e.g., unaccent_atom/2. The default is to skip normalization (false).
zero_to_one(+Boolean)
The old isub implementation deviated from the original algorithm by returning a value in the [0,1] range. This new isub/4 implementation defaults to the original range of [-1,1], but this option can be set to true to set the output range to [0,1].
substring_threshold(+Nonneg)
The original algorithm was meant to compare terms in semantic web ontologies, and it had a hard coded parameter that only considered substring similarities greater than 2 characters. This caused the similarity between, for example 'aa' and 'aa' to return -0.8 which is not expected. This option allows the user to set any threshold, such as 0, so that the similatiry between short substrings can be properly recognized. The default value is 2 which is what the original algorithm used.